API Reference
Start typing to search…

List bank transfers

get
https://api.sandbox.cuentamono.com/v1/transfers

List bank transfers of your organization. This endpoint allows to filters, sort, and control pagination of the transfers you want to fetch.

Considerations:

  • API key roles allowed to consume this endpoint are "Administrator", "Preparer", and "Viewer".
Query Params
integer
≥ 1
Defaults to 1

Number of the page

integer
10 to 500
Defaults to 10

Amount of registers that must be listed by page

string

Filters by the transfer ID

string
length between 1 and 255
deprecated

Filters by external ID. This query param will be ignored if external_id is present. Deprecated; will be removed in the future. Please use the external_id query param instead.

string
length between 1 and 255

Filters by external ID. This query param is the replacement of the entity_id. entity_id query param will be removed in the future.

inserted_at
object

Filters transfers base on creation datetime

string

Filters transfers by the specific batch were sent

string

Filters base on the bank account that money was moved from

string
enum

Filters the transfers by state

Allowed:
string
length ≥ 5

Filters the transfers by a specific payee's bank account

payee_document
object

Filters the transfers by a specific payee's national document. Number and type must be provided at the same time.

sort
object

Sorts transfers depending on the types and fields

Responses

Callback

Updated 6 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago