EasyflowEasyflowDocs

List payments link

GET/payment-links/list

Returns a list of payment links.

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

Query parameters

  • pageinteger

    Page number. Defaults to 1.

    Default:1

  • limitinteger

    Number of items per page. Defaults to 20.

    Default:20

  • fieldstring

    Text searched in the name or in the ID of the payment link. The search ignores uppercase and lowercase and matches part of the text.

  • statusarray of strings

    Returns the payment links in any of the informed statuses. Repeat the parameter (status=active&status=draft) or separate the values with commas.

    Possible values:draftactiveinactiveexpiredcanceled

  • paymentMethodarray of strings

    Returns the payment links that accept any of the informed payment methods. Repeat the parameter or separate the values with commas. Payment links without supportedPaymentMethods accept every method and are always returned.

    Possible values:credit-cardpixbank-billetcryptodebit-cardtransfer

  • initialValueinteger

    Minimum value of the payment link in cents, inclusive. Send it together with endValue.

  • endValueinteger

    Maximum value of the payment link in cents, inclusive. Send it together with initialValue.

Responses

200Returns a list of payments link.

Returns a list of payments link.

Content typeapplication/jsonobject

  • statusCodeinteger

    Example:200

  • dataobject
    Show child attributesHide child attributes
    • paymentLinksobject
      Show child attributesHide child attributes
      • docsarray of objects
        Show child attributesHide child attributes
        • paymentLinkobject
          Show child attributesHide child attributes
          • idstring
          • businessobject
            Show child attributesHide child attributes
            • idstring
            • namestring
          • createdAtstring
          • updatedAtstring
          • deletedAtstringnullable
          • deletedboolean
          • checkoutobject
            Show child attributesHide child attributes
            • idstring
            • namestring
            • colorstring
            • themestring
            • showSellerNameboolean
            • requestDeliveryAddressboolean
            • requestAddressboolean
            • acceptNaturalPersonBuyerboolean
            • acceptCorporationBuyerboolean
            • couponOnTopboolean
            • creditCardobject
              Show child attributesHide child attributes
              • defaultInstallmentsinteger
              • maxInstallmentsinteger
            • billetobject
              Show child attributesHide child attributes
              • dueDateDelayinteger
            • pixobject
              Show child attributesHide child attributes
              • expirationInMinutesinteger
          • imageobject
            Show child attributesHide child attributes
            • namestringnullable
            • pathstringnullable
            • urlstringnullable
            • isPublicstringnullable
            • extensionstringnullable
          • namestring
          • descriptionstring
          • statusstring
          • valueInCentsinteger
          • unpublishedAtstring
          • publishedAtstring
          • distUrlstring
          • preferenceobject
            Show child attributesHide child attributes
            • showSellerNameboolean
            • requestAddressboolean
            • acceptNaturalPersonBuyerboolean
            • acceptCorporationBuyerboolean
            • requestDeliveryAddressboolean
          • paymentConfigurationobject
            Show child attributesHide child attributes
            • creditCardobject
              Show child attributesHide child attributes
              • defaultInstallmentsinteger
              • maxInstallmentsinteger
            • billetobject
              Show child attributesHide child attributes
              • dueDateDelayinteger
            • pixobject
              Show child attributesHide child attributes
              • expirationInMinutesinteger
          • supportContactobject
            Show child attributesHide child attributes
            • idstring
            • namestring
            • emailstring
            • validatedstring
        • totalPaymentsinteger
      • limitinteger
      • currentPageinteger
      • nextPageintegernullable
      • totalPagesinteger
      • totalDocsinteger
      • hasNextboolean
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