v1

latestOpenAPI 3.0.02026-07-2464438356.8 KB
Payouts

Search Payout Requests

Get all Payout Requests associated with the provided Organization ID and filtered by the provided statuses.

post/api/payouts/search

Query parameters

limitnumber
nextIdstring uuid

Headers

on-behalf-ofstring

Organization ID to act on behalf of

Request body

Response

Returned Payout Requests

nextIdstring uuid
totalnumber required

Example response

{
  "results": [
    {
      "payouts": [
        {
          "amount": {
            "tokenSymbol": "USDC"
          },
          "details": {
            "feeTotal": {
              "tokenSymbol": "USDC"
            },
            "fiatAmount": {
              "fiatCurrencyCode": "USD"
            },
            "transactionFee": {
              "tokenSymbol": "USDC"
            }
          },
          "recipientInfo": {
            "details": {
              "details": {
                "truncatedBankAccountNumber": "****1234"
              }
            }
          }
        }
      ]
    }
  ]
}