List payment destinations

Lists payment destinations for a beneficiary. Optionally filter by payment method using the method query parameter.

GET /beneficiaries/{beneficiaryId}/payment-destinations

List payment destinations

cURL

curl --request GET \
  --url https://api.zeam.money/gw/v1/beneficiaries/{beneficiaryId}/payment-destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'x-zeam-auth: <api-key>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "method": "BANK",
      "label": "<string>",
      "isPrimary": true,
      "countryIso": "<string>",
      "countryName": "<string>",
      "currencyCode": "<string>",
      "region": "<string>",
      "bankName": "<string>",
      "bankCode": "<string>",
      "accountNumber": "<string>",
      "accountName": "<string>",
      "accountType": "<string>",
      "sortCode": "<string>",
      "iban": "<string>",
      "swiftBic": "<string>",
      "branchCode": "<string>",
      "mobileNumber": "<string>",
      "networkName": "<string>",
      "assetSymbol": "<string>",
      "walletAddress": "<string>",
      "isZeamAccount": true,
      "verificationStatus": "NOT_REQUIRED",
      "verifyAsMe": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>"
    }
  ],
  "pagination": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

Authorizations

Authorization · string · header · required

Access token issued by POST /v1/auth/token.

x-zeam-auth · string · header · required

Application secret (the apiKey issued at registration), required on every request.

Path Parameters

beneficiaryId · string<uuid> · required

Beneficiary identifier.

Query Parameters

method · string

Filter by payment method (e.g. BANK, MOMO, CRYPTO).

limit · integer · default: 20

Maximum items per page. Values above 100 are treated as 100; a non-numeric or non-positive value is a 400.

Required range: 1 <= x <= 100

cursor · string

Opaque pagination cursor from a previous response.

Response

200

application/json

A page of payment destinations.

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes