Skip to main content

Update Beneficiary

PUT /beneficiaries

Description

Update an existing beneficiary.

Path Parameters

NameTypeDescription
NoneNo parameters

Request Headers

NameTypeDescription
countryCodestringCountry code of the beneficiary (required)
tenantIdstringTenant identifier (required)
userIdstringUser identifier (required)

Request Body

  • Content Type: application/json
{
"uuId": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"beneficiaryTag": "string",
"phoneNumber": "string",
"bankName": "string",
"bankCode": "string",
"accountNumber": "string",
"accountId": "string",
"userId": "string",
"deleted": true,
"alias": "string"
}

Example

PUT /beneficiaries
Content-Type: application/json
countryCode: <countryCode>
tenantId: <tenantId>
userId: <userId>

{
"uuId": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"beneficiaryTag": "string",
"phoneNumber": "string",
"bankName": "string",
"bankCode": "string",
"accountNumber": "string",
"accountId": "string",
"userId": "string",
"deleted": true,
"alias": "string"
}

Response Code: 200 - OK Description

Successful.

Response Fields

Response Fields

NameTypeDescription
statusbooleanStatus of the response
statusCodenumberStatus code of the response
messagestringResponse message
dataobjectData
errorsarrayList of errors
{
"status": true,
"statusCode": 0,
"message": "string",
"data": {},
"errors": [
{
"message": "string",
"descriptiveMessage": "string"
}
]
}

Example

{
"status": true,
"statusCode": 0,
"message": "string",
"data": {},
"errors": [
{
"message": "string",
"descriptiveMessage": "string"
}
]
}

Method: PUT

>http://20.87.230.105/platform/wallets/beneficiaries

Headers

Content-TypeValue
Content-Typeapplication/json
countryCode<countryCode>
tenantId<tenantId>
userId<userId>

Body

{
"uuId": "string",
"firstName": "string",
"lastName": "string",
"middleName": "string",
"beneficiaryTag": "string",
"phoneNumber": "string",
"bankName": "string",
"bankCode": "string",
"accountNumber": "string",
"accountId": "string",
"userId": "string",
"deleted": true,
"alias": "string"
}

🔑 Authentication bearer

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PUT \ 
--url /beneficiaries \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!