Add Beneficiary

Description

This endpoint POST {{baseUrl}}/beneficiaries allows you to add a new beneficiary. The request requires a bearer token for authentication.

Note: To Add Payment details to the Beneficiary see Add beneficiary payment detail

Request Headers

• Content-Type: application/json

• Authorization: Bearer <your_token>

ex-Add Beneficiary

post

Authorizations

Body

all ofOptional

and

anyOptionalExample: {"mode":"monnet","nickname":"Monnet Mexico (Clave successful)","currency":"MXN","description":"Payout sample object for Mexico (Clave)","address":{"street":"Mexico","houseNumber":"966","additionalInfo":"Payout sample object for Mexico (Clave)","city":"CABA","province":"Lima","zipCode":"1408"},"beneficiary":{"name":"Sergio","lastName":"test","email":"[e-mail]","document":{"type":1,"number":"33446836"}},"destination":{"bankAccount":{"bankCode":"002","clave":"646180110400000007","accountType":1}}}

Responses

Responseall of

and

anyOptionalExample: {"status":"success","status_code":200,"message":"Request successful","data":{"user_id":2,"nickname":"John Doe Zenith bank","mode":"unknown","currency":"NGN","address":{"city":"Lugbe","state":"FCT - Abuja","country":"Nigeria","postal_code":"900709"},"beneficiary":{"name":"Yativo Smith","email":"[e-mail]"},"payment_object":{"bank_name":"Access bank","bank_code":"044","account_number":"0719841763","account_name":"Yativo Smith"}}}

post

HTTPcURLJavaScriptPython

POST /api/v1/beneficiaries HTTP/1.1
Host: smtp.yativo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 504

{
  "mode": "monnet",
  "nickname": "Monnet Mexico (Clave successful)",
  "currency": "MXN",
  "description": "Payout sample object for Mexico (Clave)",
  "address": {
    "street": "Mexico",
    "houseNumber": "966",
    "additionalInfo": "Payout sample object for Mexico (Clave)",
    "city": "CABA",
    "province": "Lima",
    "zipCode": "1408"
  },
  "beneficiary": {
    "name": "Sergio",
    "lastName": "test",
    "email": "[e-mail]",
    "document": {
      "type": 1,
      "number": "33446836"
    }
  },
  "destination": {
    "bankAccount": {
      "bankCode": "002",
      "clave": "646180110400000007",
      "accountType": 1
    }
  }
}

200

OK

{
  "status": "success",
  "status_code": 200,
  "message": "Request successful",
  "data": {
    "user_id": 2,
    "nickname": "John Doe Zenith bank",
    "mode": "unknown",
    "currency": "NGN",
    "address": {
      "city": "Lugbe",
      "state": "FCT - Abuja",
      "country": "Nigeria",
      "postal_code": "900709"
    },
    "beneficiary": {
      "name": "Yativo Smith",
      "email": "[e-mail]"
    },
    "payment_object": {
      "bank_name": "Access bank",
      "bank_code": "044",
      "account_number": "0719841763",
      "account_name": "Yativo Smith"
    }
  }
}

Python

import requests
import json

url = "{{baseUrl}}/beneficiaries"
data = {
    "recipient_type": "individual",
    "customer_name": "John Smith",
    "customer_email": "[e-mail]",
    "country": "Nigeria",
    "customer_address": {
        "address_line_1": "1st episode john doe street",
        "address_line_2": "this can be null",
        "city": "Ikeja",
        "county": "Lagos",
        "postal_code": 900901
    }
}
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9'
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())

PHP

$url = "{{baseUrl}}/beneficiaries";
$data = array(
    "recipient_type" => "individual",
    "customer_name" => "John Smith",
    "customer_email" => "[e-mail]",
    "country" => "Nigeria",
    "customer_address" => array(
        "address_line_1" => "1st episode john doe street",
        "address_line_2" => "this can be null",
        "city" => "Ikeja",
        "county" => "Lagos",
        "postal_code" => 900901
    )
);
$data_json = json_encode($data);

$headers = array(
    'Content-Type: application/json',
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9'
);

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => $url,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $data_json,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers
));

$response = curl_exec($curl);

if (curl_errno($curl)) {
    echo 'Error:' . curl_error($curl);
} else {
    echo $response;
}

curl_close($curl);

JavaScript

const url = "{{baseUrl}}/beneficiaries";
const data = {
    "recipient_type": "individual",
    "customer_name": "John Smith",
    "customer_email": "[e-mail]",
    "country": "Nigeria",
    "customer_address": {
        "address_line_1": "1st episode john doe street",
        "address_line_2": "this can be null",
        "city": "Ikeja",
        "county": "Lagos",
        "postal_code": 900901
    }
};

const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9'
  },
  body: JSON.stringify(data)
};

fetch(url, options)
  .then(response => {
    if (!response.ok) {
      throw new Error('Network response was not ok ' + response.statusText);
    }
    return response.json();
  })
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

cURL

curl -X POST {{baseUrl}}/beneficiaries \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9" \
-d '{
    "recipient_type": "individual",
    "customer_name": "John Smith",
    "customer_email": "[e-mail]",
    "country": "Nigeria",
    "customer_address": {
        "address_line_1": "1st episode john doe street",
        "address_line_2": "this can be null",
        "city": "Ikeja",
        "county": "Lagos",
        "postal_code": 900901
    }
}'