v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB

Payout Methods

Create a Payout Method

Creates a new payout method for a counterparty. This stores the payment details (bank account, blockchain address, etc.) that can be referenced when creating a payout within a payout requests.

post/api/counterparties/{id}/payout-methods

Path parameters

idstring uuid required

Counterparty ID

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Request body

aliasstring required

Internal user-friendly alias name for this payout method

Example request

{
  "payoutMethod": {
    "details": {
      "bankId": "bank_usd_peru_001"
    }
  }
}

Response

The successfully created payout method

aliasstring required

Internal user-friendly alias name for this payout method

counterpartyIdstring uuid required

ID of the counterparty this payout method belongs to

createdAtstring date-time required

Timestamp when the payout method was created

idstring uuid required

Unique identifier for the payout method

Example response

{
  "payoutMethod": {
    "details": {
      "bankAccountNumberTruncated": "****1234",
      "bankRoutingNumberTruncated": "****0021"
    }
  }
}