BYbyaccrue
CounterpartyTransfers

List Counterparty Transfers

List all counterparty transfers for the authenticated partner.

get/api/v1/counterparty-transfers/

Request

Query parameters

page[limit]number

Maximum number of objects that will be returned. Can not be greater than 50.

page[offset]number

Offset from the beginning of the list of objects. Can not be negative.

filter[fromCounterpartyId]string uuid

Filter transfers by source counterparty ID.

Example:123e4567-e89b-12d3-a456-426614174000
filter[toCounterpartyId]string uuid

Filter transfers by destination counterparty ID.

Example:123e4567-e89b-12d3-a456-426614174000
filter[status]'Pending' | 'Completed' | 'Failed'

Filter transfers by status.

Example:Completed
filter[createdAfter]string date-time

Filter transfers created after this ISO 8601 datetime.

Example:2024-01-01T00:00:00.000Z
filter[createdBefore]string date-time

Filter transfers created before this ISO 8601 datetime.

Example:2024-12-31T23:59:59.999Z

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "fromCounterpartyId": "123e4567-e89b-12d3-a456-426614174000",
        "toCounterpartyId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 1500,
        "status": "Completed",
        "idempotencyKey": "transfer_12345",
        "externalLedgerTransactionId": "lt_abc123",
        "metadata": {
          "orderId": "order_123"
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.