Sign in

v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB
Payout Methods

Get a Payout Method

Retrieves a single payout method by ID for a counterparty.

get/api/counterparties/{id}/payout-methods/{payoutMethodId}

Path parameters

idstring uuid required

Counterparty ID

payoutMethodIdstring uuid required

Payout Method ID

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Response

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