Skip to main content
POST
/
v1
/
beneficiaries
/
{id}
/
delete
Delete Beneficiary
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/beneficiaries/{id}/delete \
  --header 'x-auth-token: <api-key>'
{}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Path Parameters

​
id
string<uuid>
required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

Response

OK - Successfully delete a beneficiary.

The response is of type object.