Add Beneficiary Payment Details
Last updated
Last updated
To add Payment details to a beneficiary:
Make a GET
{{baseUrl}}/beneficiary/form/show/{{gatewayID}}
to get the Dynamic Form (The form response is different for each gateway) for adding the beneficiary details
Headers
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
Request Example
Example response of the Dynamic Form
Make a post request using the filled dynamic form as body
POST
{{baseUrl}}/beneficiaries/payment-methods/
this form Requires the Beneficiary ID (gotten in the response when you Add Beneficiary or Get Beneficiaries) to bind the payment details to the Beneficiary
Headers
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
Request Example
NOTE: This body example matches the retrieved dynamic form from Gateway ID 331 in the above example
Example Request
This POST request is used to create payment methods for beneficiaries.
The response for this request follows the JSON schema below:
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"status_code": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}
}
}
With a unique flow for all methods as below
{
"gateway_id": int,
"nickname": string,
"beneficiary_id": int,
"address": {
"street": string,
"houseNumber": string,
"additionalInfo": string,
"city": "string",
"province": "string",
"zipCode": string
},
"payment_data": {
...
}
}