EasyflowEasyflowDocs

Create payment link

POST/payment-links

Route to create payment link.

The payment link is created with the draft status. When paymentConfiguration.billet.dueDateDelay is sent, preference.requestAddress is set to true.

valueInCents must be greater than zero. A value equal to or lower than zero returns 400 with Error: The field valueInCents must be bigger than zero, without errorCode, before the recurrence rules below are checked.

Recurring payment link:

  • Send subscription to make the payment link recurring. Each buyer who subscribes through it with a credit card starts a subscription with these terms. The subscription is created as soon as the first order is charged, whatever the result of the card: Easyflow sends subscription.created, and, if the first order is refused, the subscription is canceled and Easyflow sends subscription.canceled. The payment link is saved with supportedPaymentMethods equal to ["credit-card"].
  • With subscription, valueInCents must be an integer equal to or greater than the minimum charge value of the platform (by default, 1000). Otherwise the API returns 400 with Invalid param: [valueInCents] and errorCode PAYMENT_LINK_SUBSCRIPTION_BELOW_MINIMUM_VALUE.
  • With subscription, supportedPaymentMethods must be omitted or contain only credit-card. A list with another method, null or an empty list returns 400 with Invalid param: [supportedPaymentMethods] and errorCode PAYMENT_LINK_SUBSCRIPTION_CREDIT_CARD_ONLY.
  • An invalid field of subscription returns 400 with the field name prefixed by subscription., such as Missing param: [subscription.periodicity], Invalid param: [subscription.numberRecurrences] or Invalid param: [subscription.retry.intervalInDays].
  • A recurring payment link cannot be paid with Create charge. The buyer subscribes through the Easyflow checkout of the payment link.

Headers

  • x-api-keystringrequired

    Api key provided on integrations tab in Easyflow platform.

  • x-api-secretstringrequired

    Api Secret provided on integrations tab in Easyflow platform.

  • business-idstringrequired

    Business Identifier

Request body

Content typeapplication/jsonobject

  • namestringrequired
  • descriptionstringrequired
  • valueInCentsintegerrequired

    Value of the payment link in cents. Must be greater than zero.

  • checkoutTemplateIdstring · uuid

    ID of the checkout template. When omitted, the default checkout template of the business is used.

  • 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. When omitted, the default contact email of the business is used.

    Show child attributesHide child attributes
    • contactEmailIdstring · uuidrequired

      ID of a validated contact email of the business.

  • advancedobject
    Show child attributesHide child attributes
    • redirectobject

      Redirect shown to the buyer after the payment.

      Show child attributesHide child attributes
      • urlstring
      • buttonNamestring
      • delayInSecondsintegernullable
    • buyerWhitelistobject
      Show child attributesHide child attributes
      • emailDomainsarray of strings

        Email domains allowed to buy with the payment link, such as example.com. Empty or omitted means that any email can buy.

  • 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.

  • payerobject

    Data of the payer of the payment link.

    Show child attributesHide child attributes
    • namestringrequired
    • emailstringrequired
    • documentobjectrequired
      Show child attributesHide child attributes
      • typestringrequired

        Possible values:CPFCNPJ

      • numberstringrequired

        Document number with digits only.

    • phoneobject
      Show child attributesHide child attributes
      • areaCodestring

        Example:+55

      • dddstring

        Example:11

      • numberstring

        Example:912345678

      • isMobileboolean
    • addressobject
      Show child attributesHide child attributes
      • zipCodestring

        Zip code with digits only, such as 01310100.

      • streetstring
      • numberstring
      • complementstring
      • neighborhoodstring
      • citystring
      • statestring

        State code with 2 letters, such as SP.

    • deliveryAddressobject
      Show child attributesHide child attributes
      • zipCodestring

        Zip code with digits only, such as 01310100.

      • streetstring
      • numberstring
      • complementstring
      • neighborhoodstring
      • citystring
      • statestring

        State code with 2 letters, such as SP.

  • expiresAtstring · date-time

    Date and time when the payment link expires. When omitted, the link does not expire.

  • maxOrdersPerLinkinteger

    Number of paid orders after which the payment link is canceled. When omitted, there is no limit.

  • supportedPaymentMethodsarray of strings

    Payment methods that the payment link presents. When omitted, all payment methods are presented. With subscription, omit it or send only credit-card.

    Possible values:credit-cardpixbank-billetcryptodebit-cardtransfer

  • subscriptionobject

    Send it to make the payment link recurring. The payment link then accepts only credit card and is saved with supportedPaymentMethods equal to ["credit-card"].

    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

Responses

200OK

OK

Content typeapplication/jsonobject

  • statusCodeinteger

    Example:200

  • dataobject
    Show child attributesHide child attributes
    • paymentLinkobject
      Show child attributesHide child attributes
      • idstring
      • createdAtstring
      • updatedAtstring
      • deletedAtstringnullable
      • deletedboolean
      • businessstring
      • checkoutstring
      • imageobject
        Show child attributesHide child attributes
        • namestringnullable
        • pathstringnullable
        • urlstringnullable
        • isPublicbooleannullable
        • extensionstringnullable
      • namestring
      • descriptionstring
      • statusstring
      • valueInCentsinteger
      • unpublishedAtstring
      • publishedAtstring
      • distUrlstring
      • preferenceobject
        Show child attributesHide child attributes
        • acceptCorporationBuyerboolean
        • acceptNaturalPersonBuyerboolean
        • requestAddressboolean
        • requestDeliveryAddressboolean
      • supportContactobject
        Show child attributesHide child attributes
        • contactEmailobject
          Show child attributesHide child attributes
          • idstring
        • namestringnullable
        • emailstringnullable
        • validatedbooleannullable
      • advancedobject
        Show child attributesHide child attributes
        • redirectobject
          Show child attributesHide child attributes
          • buttonNamestring
          • urlstring
          • delayInSecondsintegernullable
      • 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
          • invoiceDescriptionstring
          • maxInstallmentsinteger
          • installmentOptionsarray of objects
            Show child attributesHide child attributes
            • installmentsinteger
            • installmentValueInCentsintegernullable
            • interestRateintegernullable
      • supportedPaymentMethodsarray of stringsnullable

        Payment methods that the payment link presents. null or omitted means that all payment methods are presented. It is ["credit-card"] when the payment link has subscription.

        Possible values:credit-cardpixbank-billetcryptodebit-cardtransfer

      • subscriptionobject

        Recurrence terms of the payment link. Present only when the payment link is recurring. retry is omitted 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

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