EasyflowEasyflowDocs

Get payment link

GET/payment-links/details/{paymentLinkId}

Returns the details of a payment link.

Path parameters

  • paymentLinkIdstringrequired

Responses

200Returns the details of a payment link.

Returns the details of a payment link.

Content typeapplication/jsonobject

  • statusCodeinteger

    Example:200

  • dataobject
    Show child attributesHide child attributes
    • businessobject
      Show child attributesHide child attributes
      • idstring
      • namestring
    • checkoutobject

      Checkout template used by the payment link.

      Show child attributesHide child attributes
      • idstring
      • namestring
      • themestring
      • colorstring
      • acceptCorporationBuyerboolean
      • acceptNaturalPersonBuyerboolean
      • billetobject
        Show child attributesHide child attributes
        • dueDateDelayinteger
      • creditCardobject
        Show child attributesHide child attributes
        • defaultInstallmentsinteger
        • maxInstallmentsinteger
      • pixobject
        Show child attributesHide child attributes
        • expirationInMinutesinteger
      • requestAddressboolean
      • requestDeliveryAddressboolean
      • showSellerNameboolean
    • imageobject
      Show child attributesHide child attributes
      • namestringnullable
      • pathstringnullable
      • urlstringnullable
      • isPublicbooleannullable
      • extensionstringnullable

        Possible values:pngjpgjpeg

    • namestring
    • descriptionstring
    • statusstring

      Possible values:draftactiveinactiveexpiredcanceled

    • valueInCentsinteger
    • unpublishedAtstringnullable
    • publishedAtstringnullable
    • distUrlstring
    • supportedPaymentMethodsarray of stringsnullable

      Payment methods that the payment link presents. null means that all payment methods are presented.

      Possible values:credit-cardpixbank-billetcryptodebit-cardtransfer

    • subscriptionobjectnullable

      Recurrence terms of the payment link. null when the payment link charges once. retry is null when the default retry applies.

      Show child attributesHide child attributes
      • periodicitystringrequired

        Interval between recurrences.

        Possible values:MonthlyQuarterlyBiannualyAnnualy

      • repeatIndefinitelybooleanrequired

        When true, the subscription has no end and numberRecurrences must be omitted, null or 0.

      • numberRecurrencesintegernullable

        Total number of recurrences, the first one included. Required, as an integer from 1 to 1200, when repeatIndefinitely is false. When repeatIndefinitely is true, omit it or send null or 0. In responses, it is 0 when repeatIndefinitely is true.

        <= 1200

      • retryobjectnullable

        How Easyflow retries a failed recurrence. When omitted or null, it makes 5 attempts every 3 days. When sent as an object, both fields are required.

        Show child attributesHide child attributes
        • retriesMaxNumberintegerrequired

          Maximum number of attempts, from 1 to 10.

          >= 1<= 10

        • intervalInDaysintegerrequired

          Days between attempts, from 1 to 15.

          >= 1<= 15

    • thereWasASaleboolean

      true when the payment link already has a sale.

    • advancedobject
      Show child attributesHide child attributes
      • redirectobject

        Redirect shown to the buyer after the payment.

        Show child attributesHide child attributes
        • urlstring
        • buttonNamestring
        • delayInSecondsintegernullable
    • preferenceobject

      Data that the checkout of the payment link asks from the buyer.

      Show child attributesHide child attributes
      • acceptNaturalPersonBuyerboolean
      • acceptCorporationBuyerboolean
      • requestAddressboolean
      • requestDeliveryAddressboolean
      • requireEmailReentryboolean
      • disableCouponFormboolean

        Default:false

    • paymentConfigurationobject
      Show child attributesHide child attributes
      • billetobject
        Show child attributesHide child attributes
        • dueDateDelayinteger
      • pixobject
        Show child attributesHide child attributes
        • expirationInMinutesinteger
      • creditCardobject
        Show child attributesHide child attributes
        • defaultInstallmentsinteger
        • maxInstallmentsinteger
        • invoiceDescriptionstring
        • installmentOptionsarray of objects
          Show child attributesHide child attributes
          • installmentsinteger
          • installmentValueInCentsintegernullable
          • interestRateintegernullable
    • supportContactobject

      Support contact shown to the buyer.

      Show child attributesHide child attributes
      • idstring
      • namestring
      • emailstring
      • validatedboolean
    • createdAtstring · date-time
    • updatedAtstring · date-time
    • pemittedSellboolean

      The field name is spelled this way in the API.

    • interestSettingsobject
      Show child attributesHide child attributes
      • sellerAbsorbsInterestbooleanrequired

        When true, the seller absorbs the installment interest and every installment option has an interest rate of 0.

    • pricesByPaymentMethodarray of objects

      One-time price of the payment link for each payment method present in paymentConfiguration (pix, billet and creditCard, in this order), with the transferred fees included. valueInCents stays the value without them. The list follows paymentConfiguration, not supportedPaymentMethods, so it can bring a method that supportedPaymentMethods does not accept.

      Show child attributesHide child attributes
      • paymentMethodstring

        Possible values:credit-cardpixbank-billetcryptodebit-cardtransfer

      • priceInCentsinteger
      • taxTransferInCentsinteger
400If the provided parameter is invalid, the API will return the following error response:

If the provided parameter is invalid, the API will return the following error response:

Content typeapplication/jsonobject

  • messagestring

    Invalid param: []

    Example:Invalid param: []

  • errorstring

    Bad Request

    Example:Bad Request

  • statusCodeinteger

    400

    Example:400

  • errorCodestring

    Code that identifies the error. Present only on some errors.

401If the request is unauthorized, the API will return the following error response:

If the request is unauthorized, the API will return the following error response:

Content typeapplication/jsonobject

  • messagestring

    Invalid field

    Example:Unauthorized

  • errorstring

    Unauthorized

    Example:Unauthorized

  • statusCodeinteger

    401

    Example:401

403If the request is forbidden, the API will return the following error response:

If the request is forbidden, the API will return the following error response:

Content typeapplication/jsonobject

  • messagestring

    Forbidden resource

    Example:Forbidden resource

  • errorstring

    Forbidden

    Example:Forbidden

  • statusCodeinteger

    403

    Example:403

500If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

If an unexpected condition occurs and the server cannot process the request, the API will return the following error response. This response has no error field.

Content typeapplication/jsonobject

  • statusCodeinteger

    HTTP status code.

    Example:500

  • messagestring

    Explanation of the error.

    Example:Internal Server Error