Update Beneficiary
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.
Authorizations
Body
all ofOptional
and
anyOptionalExample:
{"recipient_type":"individual","customer_name":"John Smith","customer_email":"[email protected]","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": "[email protected]",
"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
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": "[email protected]",
"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": "[email protected]"
},
"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": "[email protected]",
"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())
Last updated