Create a new recipient

curl --request POST \
  --url https://api.example.com/recipient \
  --header 'ApiKey: <apikey>' \
  --header 'Content-Type: application/json' \
  --header 'Environment: <environment>' \
  --header 'MerchantId: <merchantid>' \
  --data '
{
  "lastname": "Doe",
  "firstname": "John",
  "company": "Acme Corp",
  "country": "USA",
  "type": "bank",
  "msisdn": "1234567890",
  "provider": "orange",
  "bankName": "Bank of America",
  "bankCode": "BOFAUS3N",
  "iban": "DE89370400440532013000"
}
'

import requests

url = "https://api.example.com/recipient"

payload = {
    "lastname": "Doe",
    "firstname": "John",
    "company": "Acme Corp",
    "country": "USA",
    "type": "bank",
    "msisdn": "1234567890",
    "provider": "orange",
    "bankName": "Bank of America",
    "bankCode": "BOFAUS3N",
    "iban": "DE89370400440532013000"
}
headers = {
    "ApiKey": "<apikey>",
    "MerchantId": "<merchantid>",
    "Environment": "<environment>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    ApiKey: '<apikey>',
    MerchantId: '<merchantid>',
    Environment: '<environment>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    lastname: 'Doe',
    firstname: 'John',
    company: 'Acme Corp',
    country: 'USA',
    type: 'bank',
    msisdn: '1234567890',
    provider: 'orange',
    bankName: 'Bank of America',
    bankCode: 'BOFAUS3N',
    iban: 'DE89370400440532013000'
  })
};

fetch('https://api.example.com/recipient', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/recipient",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'lastname' => 'Doe',
    'firstname' => 'John',
    'company' => 'Acme Corp',
    'country' => 'USA',
    'type' => 'bank',
    'msisdn' => '1234567890',
    'provider' => 'orange',
    'bankName' => 'Bank of America',
    'bankCode' => 'BOFAUS3N',
    'iban' => 'DE89370400440532013000'
  ]),
  CURLOPT_HTTPHEADER => [
    "ApiKey: <apikey>",
    "Content-Type: application/json",
    "Environment: <environment>",
    "MerchantId: <merchantid>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/recipient"

	payload := strings.NewReader("{\n  \"lastname\": \"Doe\",\n  \"firstname\": \"John\",\n  \"company\": \"Acme Corp\",\n  \"country\": \"USA\",\n  \"type\": \"bank\",\n  \"msisdn\": \"1234567890\",\n  \"provider\": \"orange\",\n  \"bankName\": \"Bank of America\",\n  \"bankCode\": \"BOFAUS3N\",\n  \"iban\": \"DE89370400440532013000\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ApiKey", "<apikey>")
	req.Header.Add("MerchantId", "<merchantid>")
	req.Header.Add("Environment", "<environment>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/recipient")
  .header("ApiKey", "<apikey>")
  .header("MerchantId", "<merchantid>")
  .header("Environment", "<environment>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lastname\": \"Doe\",\n  \"firstname\": \"John\",\n  \"company\": \"Acme Corp\",\n  \"country\": \"USA\",\n  \"type\": \"bank\",\n  \"msisdn\": \"1234567890\",\n  \"provider\": \"orange\",\n  \"bankName\": \"Bank of America\",\n  \"bankCode\": \"BOFAUS3N\",\n  \"iban\": \"DE89370400440532013000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/recipient")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"lastname\": \"Doe\",\n  \"firstname\": \"John\",\n  \"company\": \"Acme Corp\",\n  \"country\": \"USA\",\n  \"type\": \"bank\",\n  \"msisdn\": \"1234567890\",\n  \"provider\": \"orange\",\n  \"bankName\": \"Bank of America\",\n  \"bankCode\": \"BOFAUS3N\",\n  \"iban\": \"DE89370400440532013000\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "status": 401,
  "error": {
    "type": "authorization_error",
    "code": "wrong_credentials",
    "message": "L'ID marchand et/ou la clé d'API sont incorrects."
  }
}

{
  "type": "internal_error",
  "code": [
    "internal_error",
    "wrong_credentials",
    "not_granted",
    "live_mode_not_granted",
    "invalid_sandbox_msisdn",
    "invalid_url",
    "orange_invalid_url",
    "wrong_provider",
    "override_business_name",
    "do_not_override_business_name"
  ],
  "message": "An error occurred on our system. Please try again later."
}

POST

recipient

Create a new recipient

curl --request POST \
  --url https://api.example.com/recipient \
  --header 'ApiKey: <apikey>' \
  --header 'Content-Type: application/json' \
  --header 'Environment: <environment>' \
  --header 'MerchantId: <merchantid>' \
  --data '
{
  "lastname": "Doe",
  "firstname": "John",
  "company": "Acme Corp",
  "country": "USA",
  "type": "bank",
  "msisdn": "1234567890",
  "provider": "orange",
  "bankName": "Bank of America",
  "bankCode": "BOFAUS3N",
  "iban": "DE89370400440532013000"
}
'

import requests

url = "https://api.example.com/recipient"

payload = {
    "lastname": "Doe",
    "firstname": "John",
    "company": "Acme Corp",
    "country": "USA",
    "type": "bank",
    "msisdn": "1234567890",
    "provider": "orange",
    "bankName": "Bank of America",
    "bankCode": "BOFAUS3N",
    "iban": "DE89370400440532013000"
}
headers = {
    "ApiKey": "<apikey>",
    "MerchantId": "<merchantid>",
    "Environment": "<environment>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    ApiKey: '<apikey>',
    MerchantId: '<merchantid>',
    Environment: '<environment>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    lastname: 'Doe',
    firstname: 'John',
    company: 'Acme Corp',
    country: 'USA',
    type: 'bank',
    msisdn: '1234567890',
    provider: 'orange',
    bankName: 'Bank of America',
    bankCode: 'BOFAUS3N',
    iban: 'DE89370400440532013000'
  })
};

fetch('https://api.example.com/recipient', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/recipient",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'lastname' => 'Doe',
    'firstname' => 'John',
    'company' => 'Acme Corp',
    'country' => 'USA',
    'type' => 'bank',
    'msisdn' => '1234567890',
    'provider' => 'orange',
    'bankName' => 'Bank of America',
    'bankCode' => 'BOFAUS3N',
    'iban' => 'DE89370400440532013000'
  ]),
  CURLOPT_HTTPHEADER => [
    "ApiKey: <apikey>",
    "Content-Type: application/json",
    "Environment: <environment>",
    "MerchantId: <merchantid>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/recipient"

	payload := strings.NewReader("{\n  \"lastname\": \"Doe\",\n  \"firstname\": \"John\",\n  \"company\": \"Acme Corp\",\n  \"country\": \"USA\",\n  \"type\": \"bank\",\n  \"msisdn\": \"1234567890\",\n  \"provider\": \"orange\",\n  \"bankName\": \"Bank of America\",\n  \"bankCode\": \"BOFAUS3N\",\n  \"iban\": \"DE89370400440532013000\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ApiKey", "<apikey>")
	req.Header.Add("MerchantId", "<merchantid>")
	req.Header.Add("Environment", "<environment>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/recipient")
  .header("ApiKey", "<apikey>")
  .header("MerchantId", "<merchantid>")
  .header("Environment", "<environment>")
  .header("Content-Type", "application/json")
  .body("{\n  \"lastname\": \"Doe\",\n  \"firstname\": \"John\",\n  \"company\": \"Acme Corp\",\n  \"country\": \"USA\",\n  \"type\": \"bank\",\n  \"msisdn\": \"1234567890\",\n  \"provider\": \"orange\",\n  \"bankName\": \"Bank of America\",\n  \"bankCode\": \"BOFAUS3N\",\n  \"iban\": \"DE89370400440532013000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/recipient")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"lastname\": \"Doe\",\n  \"firstname\": \"John\",\n  \"company\": \"Acme Corp\",\n  \"country\": \"USA\",\n  \"type\": \"bank\",\n  \"msisdn\": \"1234567890\",\n  \"provider\": \"orange\",\n  \"bankName\": \"Bank of America\",\n  \"bankCode\": \"BOFAUS3N\",\n  \"iban\": \"DE89370400440532013000\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "status": 401,
  "error": {
    "type": "authorization_error",
    "code": "wrong_credentials",
    "message": "L'ID marchand et/ou la clé d'API sont incorrects."
  }
}

{
  "type": "internal_error",
  "code": [
    "internal_error",
    "wrong_credentials",
    "not_granted",
    "live_mode_not_granted",
    "invalid_sandbox_msisdn",
    "invalid_url",
    "orange_invalid_url",
    "wrong_provider",
    "override_business_name",
    "do_not_override_business_name"
  ],
  "message": "An error occurred on our system. Please try again later."
}

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"

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

Data

Balance

Webhooks

Sms

Payments

Provisioning

Receipt

Payment on Terminal

IRT

Transfers

Refunds

Compliance

Recipients

Processing Only

Payment Links

Submerchants

Create a new recipient

Headers

Body

Response