BYbyaccrue
CounterpartyTransfers

Create Counterparty Transfer

Initiate a transfer of funds between two counterparties owned by the authenticated partner.

post/api/v1/counterparty-transfers

Request

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

Request body

Example request

{
  "data": {
    "attributes": {
      "fromCounterpartyId": "123e4567-e89b-12d3-a456-426614174000",
      "toCounterpartyId": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 1500,
      "idempotencyKey": "transfer_12345",
      "metadata": {
        "orderId": "order_123"
      }
    }
  }
}

Response

Counterparty transfer created successfully

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"
      }
    }
  }
}

Changes

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