List subscriptions - V1

GET

/order/v1/banking/subscriptions

• Production
• Sandbox

  List and filter subscriptions with cursor-based pagination.

  

NOTE: Please, to authenticate use the scope: “api://app-order-prd”

Authorizations

• Bearer

Parameters

Query Parameters

limit

number

default: 20 >= 1 <= 5000

Maximum number of items returned in the current page (default 20, max 5000)

sort

string

default: desc

Allowed values: asc desc

Direction of the sort (default: desc)

cursor

string

Cursor used for pagination. Omit this field in the first request. For subsequent requests, set it to the nextCursor value returned in the previous response.

startDate

string

Filter by subscription recurrence start date (YYYY-MM-DD)

Example

2025-01-01

endDate

string

Filter by subscription recurrence end date (YYYY-MM-DD)

Example

2025-12-31

status

string

Allowed values: INITIAL PENDING_AUTHORIZATION ACCEPTED REJECTED CANCELED ERROR

The status of the subscriptions

Example

ACCEPTED

externalId

string

The external id of the partner

accountId

string

The account id of the receiver

Responses

200

The resource was returned successfully

object

limit

The maximum number of records returned in the current page. Corresponds to the limit value provided in the request.

number

Example

20

sort

Defines the sorting direction applied to the results. Allowed values: “asc” — ascending order, “desc” — descending order (default)

string

Allowed values: asc desc

Example

desc

nextCursor

A cursor value representing the timestamp of the last item returned in the current page. This value must be provided as the cursor parameter in the next request to continue retrieving results.

string

Example

2025-01-01T10:00:00Z

hasNext

required

Indicates whether additional pages of data are available.

boolean

Example

true

data

required

The array of subscriptions

Array<object>

object

id

required

The subscription ID

string

Example

37e036db-42dd-4a0f-ba84-5f282f0f9275

providerId

required

The provider ID of the subscription on bacen

string

Example

RR33630661202512093d0403bc2a6

type

required

The type of the QR code that was generated

string

Allowed values: AUTHORIZATION_QRCODE AUTHORIZATION_QRCODE_IMMEDIATE_PAYMENT

Example

AUTHORIZATION_QRCODE

status

required

The status of the subscription

string

Allowed values: INITIAL PENDING_AUTHORIZATION ACCEPTED REJECTED CANCELED ERROR

Example

ACCEPTED

allowChargeAfterDueDate

Whether charges are allowed after the due date

boolean

Example

true

allowAdjustToBusinessDay

Whether the due date should be automatically adjusted to the next business day when it falls on a non-business day

boolean

Example

true

frequencyType

required

The frequency of the charges

string

Allowed values: WEEKLY MONTHLY QUARTERLY SEMIANNUAL ANNUAL

Example

MONTHLY

startDate

required

The start date of the recurrence payment in ISO 8601 format (YYYY-MM-DD)

string

Example

2025-01-01

endDate

The end date of the recurrence payment in ISO 8601 format (YYYY-MM-DD)

string

Example

2025-12-31

fixedAmount

Fixed amount to be charged on each cycle

object

currency

required

The currency field.

string

Example

BRL

value

required

The value field.

string

Example

10.95

maxAmountFloor

Minimum value the payer may configure as the authorization maximum amount

object

currency

required

The currency field.

string

Example

BRL

value

required

The value field.

string

Example

10.95

debtor

required

The debtor information object

object

document

required

The debtor document

object

type

required

Document type

string

Allowed values: CPF CNPJ

Example

CPF

number

required

Document number

string

Example

12345678910

Example

{
  "type": "CPF",
  "number": "12345678901"
}

name

required

The debtor name

string

Example

John Doe

receiver

required

The receiver information object

object

id

required

The receiver account ID

string

Example

aa592d24-3f06-4957-ac98-8094ebe059d7

fullName

required

The full name of the receiver

string

Example

John Doe Organization

document

required

The receiver document

object

type

required

Document type

string

Allowed values: CPF CNPJ

Example

CPF

number

required

Document number

string

Example

12345678910

Example

{
  "type": "CNPJ",
  "number": "33023355667842"
}

payer

The payer information object (available after subscription is accepted)

object

name

The payer name

string

Example

John Doe

document

required

The payer document

object

type

required

Document type

string

Allowed values: CPF CNPJ

Example

CPF

number

required

Document number

string

Example

12345678910

Example

{
  "type": "CPF",
  "number": "12345678901"
}

bankData

The payer bank data

object

ispb

required

The payer bank ISPB

string

Example

12345678

accountNumber

required

The payer bank account number

string

Example

00012345

branchNumber

The payer bank branch number

string

Example

0001

description

The description of the subscription

string

Example

Monthly subscription for premium service

webhookUrl

required

The URL that will receive updates about the status of the subscription

string

Example

https://partner.example.com/webhooks/subscription

externalId

required

The unique code on the partner system

string

Example

partner-id

createdAt

required

The date and time when the resource was created, in ISO 8601 format (RFC 3339), UTC

string

Example

2025-01-01T10:00:00Z

updatedAt

The date and time when the resource was last updated, in ISO 8601 format (RFC 3339), UTC

string

Example

2025-01-15T14:30:00Z

400

object

error

string

Example

INVALID_REQUEST

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

403

object

error

string

Example

FORBIDDEN_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]