🇬🇧
Yativo Documentation
Spanish
English
English
  • Yativo
  • Introduction to Yativo
    • Financial Infrastructure
    • About Us
  • Dashboard
  • Business Plans
  • Getting Started with Yativo API
  • Yativo API Glossary
  • API reference
    • Misc.
      • Countries
      • States
      • City
  • Security and Authentication
    • Security
    • Authentication
    • Idempotency in API Requests
  • Environment
    • Environments
  • Notifications
    • Webhook
  • Compliance
    • Verification
      • KYC
      • KYB
      • KYC/KYB Update
      • KYC Status
      • Global Business Search
    • Supported Jurisdiction
    • Supported Countries, Currencies and Payment Method
  • User Management
    • Customer
      • Get Customers
      • Retrieve customer
      • Add Customer
  • Payments
    • Currencies
    • Crypto Wallets
      • Generate Wallet Address
      • Fetch Wallet Address
      • Crypto Deposit History
      • Single crypto deposit history
    • Payout
      • Payout
      • Get Payouts
      • Get Payout
      • Beneficiaries
        • Get Beneficiaries
        • Add Beneficiary Payment Details
        • Update Beneficiary
        • Archive Beneficiary
        • Add Beneficiary
    • Payin
    • Virtual Cards
      • Supported Currency, Country
      • Create card
      • Fetch card
      • Top up card
      • Get Transactions
      • Freeze and Unfreeze Card
    • Virtual Accounts
      • Create VIrtual Accounts
        • USD Virtual Account
        • Mexico Virtual Account
        • Brazil PIX QR
      • Virtual Account Management
      • Transaction History
  • Foreign Exchange
    • Exchange Rate
      • Request Quote
  • Transactions
    • Transaction Summary
    • Get Single Transaction
  • Crypto System
    • Yativo Crypto Platform API
Powered by GitBook
On this page
  1. Payments
  2. Payout
  3. Beneficiaries

Update Beneficiary

PreviousAdd Beneficiary Payment DetailsNextArchive Beneficiary

Last updated 2 months ago

Endpoint

PUT {{baseUrl}}/beneficiaries/{beneficiaryID}

Description

This endpoint updates the details of an existing beneficiary. The beneficiaryID in the URL is the ID of the beneficiary to be updated, which is included in the beneficiary object.

Request

Headers

  • Authorization: Bearer YOUR_ACCESS_TOKEN

  • Content-Type: application/json

URL Parameters

  • beneficiaryID: The ID of the beneficiary to be updated.

Request Body

The request body should contain the fields to be updated. Here is an example of the request body with all the fields that can be updated:

{
    "recipient_type": "individual",
    "customer_name": "John Smith",
    "customer_email": "john@yativo.com",
    "country": "Chile",
    "customer_address": {
        "address_line_1": "1st episode john doe street",
        "address_line_2": "this can be null",
        "city": "Santiago",
        "county": "Chile",
        "postal_code": 900901
    }
}

Response

Example Success Response

{
  "status": "success",
  "status_code": 200,
  "message": "Beneficiary updated successfully",
  "data": {
    "id": 1,
    "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": "john@yativo.com"
    },
    "payment_object": {
      "bank_name": "Access bank",
      "bank_code": "044",
      "account_number": "0719841763",
      "account_name": "Yativo Smith"
    },
    "created_at": "2024-02-06T21:07:39.000000Z",
    "updated_at": "2024-02-06T21:07:39.000000Z",
    "deleted_at": null
  }
}

Request example

import requests
import json

beneficiary_id = "1"  # Example beneficiary ID
url = f"https://api.yourservice.com/beneficiaries/{beneficiary_id}"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "recipient_type": "individual",
    "customer_name": "John Smith",
    "customer_email": "john@yativo.com",
    "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
    }
}

response = requests.put(url, headers=headers, data=json.dumps(data))
print(response.json())
<?php

$beneficiary_id = "1";  // Example beneficiary ID
$url = "https://api.yourservice.com/beneficiaries/" . $beneficiary_id;
$headers = array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "Content-Type: application/json"
);
$data = json_encode(array(
    "recipient_type" => "individual",
    "customer_name" => "John Smith",
    "customer_email" => "john@yativo.com",
    "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
    )
));

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_POSTFIELDS => $data
));

$response = curl_exec($curl);

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

curl_close($curl);
?>
const beneficiary_id = "1"; // Example beneficiary ID
const url = `https://api.yourservice.com/beneficiaries/${beneficiary_id}`;

const data = {
  "recipient_type": "individual",
  "customer_name": "John Smith",
  "customer_email": "john@yativo.com",
  "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: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  },
  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 -X PUT "https://api.yourservice.com/beneficiaries/1" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
           "recipient_type": "individual",
           "customer_name": "John Smith",
           "customer_email": "john@yativo.com",
           "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
           }
         }'

Update Beneficiary

put
Authorizations
Body
all ofOptional
and
anyOptionalExample: {"recipient_type":"individual","customer_name":"John Smith","customer_email":"john@yativo.com","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}}
Responses
200Success
put
PUT /api/v1/beneficiaries/6 HTTP/1.1
Host: smtp.yativo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "recipient_type": "individual",
  "customer_name": "John Smith",
  "customer_email": "john@yativo.com",
  "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
  }
}
200Success

No content