POST
/
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

Body

application/json
​
lastname
string
required

Last name of the recipient

Example:

"Doe"

​
firstname
string
required

First name of the recipient

Example:

"John"

​
company
string
required

Company name of the recipient

Example:

"Acme Corp"

​
country
string
required

Country of the recipient

Example:

"USA"

​
type
enum<string>
required

Recipient type

Available options:
mobile,
bank
Example:

"bank"

​
msisdn
string

Recipient phone number (required if type is mobile)

Example:

"1234567890"

​
provider
string

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

Example:

"orange"

​
bankName
string

Name of the bank (required if type is bank)

Example:

"Bank of America"

​
bankCode
string

Bank code (required if type is bank)

Example:

"BOFAUS3N"

​
iban
string

International Bank Account Number (IBAN)

Example:

"DE89370400440532013000"

Response

​
lastname
string
required

Last name of the recipient

Example:

"Doe"

​
firstname
string
required

First name of the recipient

Example:

"John"

​
company
string
required

Company name of the recipient

Example:

"Acme Corp"

​
country
string
required

Country of the recipient

Example:

"USA"

​
type
enum<string>
required

Recipient type

Available options:
mobile,
bank
Example:

"bank"

​
id
string
required

Unique identifier of the recipient

​
createdAt
string<date-time>
required

Date of creation of the recipient

​
updatedAt
string<date-time>
required

Date of last update of the recipient

​
merchantId
string
required

MerchantId of the merchant who created the recipient

​
accountNumber
string
required

IBAN of the recipient

​
isActive
boolean
required

Indicates if the recipient is active

Example:

true

​
msisdn
string

Recipient phone number (required if type is mobile)

Example:

"1234567890"

​
provider
string

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

Example:

"orange"

​
bankName
string

Name of the bank (required if type is bank)

Example:

"Bank of America"

​
bankCode
string

Bank code (required if type is bank)

Example:

"BOFAUS3N"

​
metadata
object

Metadata of the recipient. Contains information like recipient kyc

​
isIrt
boolean

Indicates if transfers are internationnal

Example:

true