GET
/
recipient
[
  {
    "lastname": "Doe",
    "firstname": "John",
    "company": "Acme Corp",
    "country": "USA",
    "type": "bank",
    "msisdn": "1234567890",
    "provider": "orange",
    "bankName": "Bank of America",
    "bankCode": "BOFAUS3N",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "merchantId": "<string>",
    "accountNumber": "<string>",
    "isActive": true,
    "metadata": {},
    "isIrt": true
  }
]

Headers

ApiKey
string
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.

MerchantId
string
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
enum<string>
required

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

Available options:
live,
sandbox

Query Parameters

bankName
string

Only recipients using the given bank name.

bankCode
string

Only recipients using the given bank code.

provider
string

Only recipients using the given provider.

Search string used in firstname and lastname

firstname
string

Recipient firstname

lastname
string

Recipient lastname

company
string

Recipient company

country
string

Recipient country

type
enum<string>

Recipient type

Available options:
mobile,
bank
msisdn
string

Only recipients having the given msisdn

iban
string

Only recipients having the given iban.

page
number
required

Page number starting from 1

limit
number
required

Number of items per page

Required range: 1 <= x <= 100

Response

200
application/json

The response is of type object[].