List bank 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".

Authorization

authorization

AuthorizationBearer <token>

In: header

Query Parameters

page_number?integer

Number of the page

Default1

Range1 <= value

Example1

page_size?integer

Amount of registers that must be listed by page

Default10

Range10 <= value <= 500

Example10

id?string

Filters by the transfer ID

Match^[A-Za-z]{2,6}_[\w-]{22}$

Example"trn_5tgliBmzjZ6mpQPRbQjfKj"

entity_id?stringDeprecated

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.

Length1 <= length <= 255

Example"123456789"

external_id?string

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

Length1 <= length <= 255

Example"123456789"

inserted_at?object

Filters transfers base on creation datetime

batch_id?string

Filters transfers by the specific batch were sent

Match^[A-Za-z]{2,6}_[\w-]{22}$

Example"bat_5tgliBmzjZ6mpQPRbQjfKj"

account_id?string

Filters base on the bank account that money was moved from

Match^[A-Za-z]{2,6}_[\w-]{22}$

Example"acc_5tgliBmzjZ6mpQPRbQjfKj"

state?string

Filters the transfers by state

payee_account_number?string

Filters the transfers by a specific payee's bank account

Length5 <= length

Example"string"

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

Default{"field":"inserted_at","type":"desc"}

Response Body

application/json

curl -X GET "https://api.cert.monoban.co/v1/transfers"

curl -X GET "https://api.cert.monoban.co/v1/transfers"

{
  "pagination": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 100,
    "total_pages": 10
  },
  "transfers": [
    {
      "fallback_routing": [],
      "payee": {
        "bank_account": {
          "bank_code": "string",
          "number": "123456789",
          "type": "savings_account"
        },
        "document_number": "string",
        "document_type": "CC",
        "email": "someone@gmail.com",
        "name": "string",
        "phone_number": "+573001000000"
      },
      "routing": "ach",
      "amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "batch": {
        "account_id": "acc_5tgliBmzjZ6mpQPRbQjfKj",
        "id": "bat_5tgliBmzjZ6mpQPRbQjfKj",
        "inserted_at": "2022-01-01T01:00:00Z",
        "origin": "api",
        "state": "created",
        "total_amount": {
          "amount": 100000000,
          "currency": "COP"
        },
        "updated_at": "2022-01-01T01:00:00Z"
      },
      "declination_reason": "insufficient_funds",
      "description": "string",
      "emails_to_notify": [
        "someone@gmail.com"
      ],
      "entity_id": "string",
      "external_id": "123456789",
      "id": "trn_5tgliBmzjZ6mpQPRbQjfKj",
      "inserted_at": "2022-01-01T01:00:00Z",
      "reference": "string",
      "state": "created",
      "updated_at": "2022-01-01T01:00:00Z"
    }
  ]
}

{
  "code": "400 Bad Request",
  "errors": [
    {
      "error_code": "validation_error",
      "message": "Generic changeset errors",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Malformed request"
}

{
  "code": "401 Unauthorized",
  "errors": [
    {
      "error_code": "expired_token",
      "message": "The token is expired, inactive, or doesn't exist.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Authorization header is missing or invalid."
}

{
  "code": "403 Forbidden",
  "errors": [
    {
      "error_code": "not_authorized",
      "message": "Not authorized to have access to this resource.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Not authorized to have access to this resource"
}

{
  "code": "422 Unprocessable Entity",
  "errors": [
    {
      "error_code": "missing_field",
      "message": "The field is missing on the request body or parameters.",
      "path": "#/path/to/field",
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Validation errors"
}

List bank transfers

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

422application/json

application/json

application/json

application/json

application/json

application/json