BVbvnk
Fiat Payments

List transfer beneficiaries

Changed on

Retrieves a list of beneficiaries eligible for transfers for a specified wallet.

get/payment/v1/transfers/{walletId}/beneficiaries

Request

Path parameters

walletIdstring uuid required
Example:a:24092328494070:G5i4XZ9:1

The wallet ID for which you are listing the eligible beneficiaries.

Query parameters

currencyCodestring required
Example:GBP

The currency code for the wallets.

walletTypestring
Example:MAIN

The type of the wallets.

customerReferencestring uuid
Example:33e85982-e22b-4e8b-9057-445cf000bea9

Customer reference for the wallets being requested.

Response

OK

walletIdstring

The unique identifier of the wallet.

namestring

Name of the wallet.

walletType'CUSTOMER' | 'MAIN'

The type of the wallet

Example response

[
  {
    "walletId": "a:24092328494070:G5i4XZ9:1",
    "name": "some description",
    "balance": {
      "value": 1000,
      "currency": "USD"
    },
    "walletType": "MAIN"
  }
]

Changes

  • 97d6c0d2fe2eRevision changes
    • breaking

      the / response's property type changed from object to array for status

    • warning

      removed the optional property // from the response with the status

    • info

      added the required property to the response with the status