Skip to main content
GET
/
api
/
v1
/
business
/
payouts
/
recipients
List payout recipients for the active business
curl --request GET \
  --url http://localhost:3001/api/v1/business/payouts/recipients \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "recipients": [
      {
        "id": "<string>",
        "businessId": "<string>",
        "label": "<string>",
        "detailsMasked": {},
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "screenedAt": {},
        "archivedAt": {}
      }
    ],
    "total": 123,
    "page": 123,
    "limit": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Axra-Business-Id
string

Active business workspace

Query Parameters

rail
enum<string>
Available options:
CRYPTO,
ACH,
WIRE,
SEPA,
SWIFT,
LOCAL_BANK,
LOCAL_MOMO
includeArchived
boolean
default:false
page
number
default:1
limit
number
default:20

Response

OK

success
boolean
required
Example:

true

data
object
required