Cards

Generate Card Invoice Statement CSV URL

get
/banking/cards/invoices/{id}/export

Generate Card Invoice Statement CSV URL for an invoice

Path parameters
idstringRequired

Invoice ID

Query parameters
entity_idstringRequired

Entity ID

card_idstringOptional

Card ID

Responses
get
/banking/cards/invoices/{id}/export

List Card Invoices

get
/banking/cards/invoices

List Card Invoices

Query parameters
entity_idstringRequired

Entity ID

beforestringOptional

Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
afterstringOptional

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
limitintegerOptional

Parameter used for pagination.

Responses
200

Invoices

application/json
get
/banking/cards/invoices

Cancel a card

post
/banking/cards/{id}/cancel

Cancel an existing card

Path parameters
idstring · uuidRequired

Unique identifier

Responses
post
/banking/cards/{id}/cancel

Get card details

get
/banking/cards/{id}/info

Card sensitive information: holder name, card number, expiration date and cvv

Path parameters
idstring · uuidRequired

Unique identifier

Responses
200

Card Details

application/json
get
/banking/cards/{id}/info

Transfer card balance to another card

post
/banking/cards/{id}/transfer_balance

Transfer card balance to another card

Path parameters
idstringRequired

From card ID

Body

Card transfer balance params

amountintegerRequired

Amount to transfer (R$)

destination_card_idstringRequired

Destination card UUID

entity_idstringRequired

Entity UUID

Responses
post
/banking/cards/{id}/transfer_balance

List Card Invoice Lines

get
/banking/cards/invoices/{id}/lines

List lines for a specific Card Invoice

Path parameters
idstringRequired

Invoice ID

Query parameters
entity_idstringRequired

Entity ID

beforestringOptional

Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
afterstringOptional

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
limitintegerOptional

Parameter used for pagination.

Responses
200

Invoice Lines

application/json
get
/banking/cards/invoices/{id}/lines

Block a card

post
/banking/cards/{id}/block

Block an existing card

Path parameters
idstring · uuidRequired

Unique identifier

Responses
post
/banking/cards/{id}/block

Get a card

get
/banking/cards/{id}

Get an existing card

Path parameters
idstring · uuidRequired

Unique identifier

Responses
200

Card

application/json
get
/banking/cards/{id}

Update a card

put
/banking/cards/{id}

Update card display name

Path parameters
idstring · uuidRequired

Unique identifier

Body

Card update params

display_namestringRequired

Display name

Responses
put
/banking/cards/{id}

Get Card current Invoice

get
/banking/cards/invoices/current

Get Card current Invoice

Query parameters
entity_idstringRequired

Entity ID

Responses
200

Invoice

application/json
get
/banking/cards/invoices/current

List Card purchase documents

get
/banking/cards/purchases

List Card purchase documents

Query parameters
entity_idstring · uuidRequired

Unique identifier

from_datetimestringRequired

From datetime

to_datetimestringRequired

To datetime

card_idstring · uuidOptional

Unique identifier

category_codestringOptional

Category Code

category_typestringOptional

Category Type

beforestringOptional

Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
afterstringOptional

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
limitintegerOptional

Parameter used for pagination.

statusstringOptional

Status

order_bystringOptional

Order by

Responses
200

Documents

application/json
get
/banking/cards/purchases

Top Up card balance

post
/banking/cards/{id}/topup

Top Up card balance

Path parameters
idstringRequired

Card ID

Body

Card top up balance params

amountintegerRequired

Amount to top up (R$)

entity_idstringRequired

Entity UUID

origin_bank_account_idstringRequired

Source bank account UUID

Responses
post
/banking/cards/{id}/topup

List cards

get
/banking/cards

List cards

Query parameters
entity_idstring · uuidRequired

Unique identifier

card_last_digitsstringOptional

Card Last Four Digits

display_namestringOptional

Card Display Name

holder_namestringOptional

Card Holder Name

holder_tax_numberstringOptional

Card Holder Tax Number

beforestringOptional

Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
afterstringOptional

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
limitintegerOptional

Parameter used for pagination.

Responses
200

Cards

application/json
get
/banking/cards

Create a card

post
/banking/cards

Create a new card

Body

Card create params

display_namestringRequired

Display name

entity_idstringRequired

Entity UUID

holder_namestring | nullableOptional

Holder Name

Responses
post
/banking/cards

Show card purchase document by end to end id

get
/banking/cards/purchases/e2e/{id}

Show card purchase document by end to end id

Path parameters
idstringRequired

Unique identifier for transactions

Example: EE202506111406IVIN5pXVoyp
Query parameters
timestampstringRequired

Timestamp

Responses
200

Document

application/json
get
/banking/cards/purchases/e2e/{id}

Show Card purchase document by id

get
/banking/cards/purchases/{id}

Show Card purchase document by id

Path parameters
idstring · uuidRequired

Unique identifier

Responses
200

Document

application/json
get
/banking/cards/purchases/{id}

Unblock a card

post
/banking/cards/{id}/unblock

Unblock an existing card

Path parameters
idstring · uuidRequired

Unique identifier

Responses
post
/banking/cards/{id}/unblock

Last updated

Was this helpful?