List outgoing transfers

Retrieves a paginated list of outgoing transfers for the authenticated tenant.

Filtering options:

state: Filter transfers by their current state (e.g., created, processing, successful, failed)
transaction_at: Filter transfers by creation datetime range in UTC using from and until datetime parameters
tenant_account_id: Filter transfers by the source tenant account
external_id: Filter transfers by their external identifier
key_type: Filter transfers by the target's key type (e.g., identification, cellphone, email)
key_value: Filter transfers by the target's key value
metadata: Filter transfers by metadata key-value pairs

Pagination: Use page_number and page_size parameters to control pagination. Results are ordered by creation date in descending order (newest first).

Authorization

AuthorizationBearer <token>

In: header

Scope: outgoing_transfers:readonly

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

state?string

Filter by transfer state

Example"successful"

transaction_at?object

Filter by transfer creation date range (from/until in UTC)

tenant_account_id?string

Filter by tenant account ID

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

Example"bbtacc_5tgliBmzjZ6mpQPRbQjfKj"

external_id?string

Filter by external ID

Lengthlength <= 255

Example"EXT_001"

key_type?string

Filter by target key type

Value in"identification" | "cellphone" | "email" | "alphanumeric" | "merchant_code"

Example"cellphone"

key_value?string

Filter by target key value

Example"3001234567"

metadata?object

Filter by metadata key-value pairs

Example

{
  "id": 3,
  "reference": 123
}

Response Body

`application/json`

curl -X GET "https://breb-participant.sandbox.mono.la/api/v1/outgoing_transfers"

{
  "pagination": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 100,
    "total_pages": 10
  },
  "transfers": [
    {
      "amount": {
        "amount": 100000000,
        "currency": "COP"
      },
      "description": "Payment to merchant",
      "external_id": "transfer_001",
      "id": "bbot_5tgliBmzjZ6mpQPRbQjfKj",
      "inserted_at": "2022-01-01T01:00:00Z",
      "metadata": {
        "id": 3,
        "reference": 123
      },
      "payment_id": "PAY123456789",
      "resolution_request_id": "bbtgr_5tgliBmzjZ6mpQPRbQjfKj",
      "state": "created",
      "state_reason": null,
      "tenant_account_id": "bbtacc_5tgliBmzjZ6mpQPRbQjfKj",
      "timemarks": {
        "T110": "2024-09-29T15:30:00.000",
        "T120": "2024-09-29T15:30:00.000"
      },
      "updated_at": "2022-01-01T01:00:00Z",
      "expected_creditor": {
        "document_number": "1234567890",
        "document_type": "CC"
      },
      "query": {
        "format": "plain_key",
        "value": "1234567890"
      },
      "target": {
        "creditor": {
          "document_number": "1234567890",
          "document_type": "CC",
          "full_name": "Juan Pérez",
          "type": "natural"
        },
        "creditor_account": {
          "currency_code": "COP",
          "number": "1234567890",
          "type": "savings_account"
        },
        "id": "bbtgt_5tgliBmzjZ6mpQPRbQjfKj",
        "key_type": "identification",
        "key_value": "1234567890",
        "participant_nit": "900123456",
        "payment_id": "string",
        "resolution_type": "plain_key",
        "spbvi": "CRB",
        "transaction_amount": {
          "amount": 100000000,
          "currency": "COP"
        }
      }
    }
  ]
}

{
  "code": "400 Bad Request",
  "errors": [
    {
      "error_code": "invalid_format",
      "message": "The field contains an invalid format.",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Malformed request"
}

{
  "code": "401 Unauthorized",
  "errors": [
    {
      "error_code": "missing_authorization_header",
      "message": "`Authorization` header is missing.",
      "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": "500 Internal Server Error",
  "errors": [
    {
      "error_code": "internal_error",
      "message": "An unexpected error occurred",
      "path": null,
      "url": null
    }
  ],
  "id": "log_7MkWaFqvfosB8fzHhb1Eql",
  "message": "Something went wrong on the Server"
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`