adb17b4b80f4

latestOpenAPI 3.0.02026-07-265892227.1 KB

Recipient

Retrieve a list of recipients according to filters

get/recipient

Query parameters

bankNamestring

Only recipients using the given bank name.

bankCodestring

Only recipients using the given bank code.

providerstring

Only recipients using the given provider.

searchstring

Search string used in firstname and lastname

firstnamestring

Recipient firstname

lastnamestring

Recipient lastname

companystring

Recipient company

countrystring

Recipient country

type'mobile' | 'bank'

Recipient type

msisdnstring

Only recipients having the given msisdn

ibanstring

Only recipients having the given iban.

pagenumber required

Example:1

Page number starting from 1

limitnumber required

Example:10

Number of items per page

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Response

lastnamestring required

Last name of the recipient

firstnamestring required

First name of the recipient

companystring required

Company name of the recipient

countrystring required

Country of the recipient

type'mobile' | 'bank' required

Recipient type

msisdnstring

Recipient phone number (required if type is mobile)

providerstring

Provider used by the recipient (required if type is mobile)

bankNamestring

Name of the bank (required if type is bank)

bankCodestring

Bank code (required if type is bank)

idstring required

Unique identifier of the recipient

createdAtstring date-time required

Date of creation of the recipient

updatedAtstring date-time required

Date of last update of the recipient

merchantIdstring required

MerchantId of the merchant who created the recipient

accountNumberstring required

IBAN of the recipient

isActiveboolean required

Indicates if the recipient is active

metadataobject

Metadata of the recipient. Contains information like recipient kyc

isIrtboolean

Indicates if transfers are internationnal

Example response

[
  {
    "lastname": "Doe",
    "firstname": "John",
    "company": "Acme Corp",
    "country": "USA",
    "type": "bank",
    "msisdn": "1234567890",
    "provider": "orange",
    "bankName": "Bank of America",
    "bankCode": "BOFAUS3N",
    "isActive": true,
    "isIrt": true
  }
]