v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB
Payers

Delete a Payer

Should you or your customers want to remove a Payer, you can do so using this API. In your DELETE request, simply add the PayerId as a slug. Please note that when a Payer is deleted, we will keep a reference to it in order to maintain the integrity of the transaction history. A success response will contain a confirmation message with a reference to the deleted payer account.

delete/v1/payments/payers/{payerId}

Path parameters

payerIdstring required

Payer Id received on adding payer account

Response

codenumber
descstring

Example response

{
  "code": 200,
  "desc": "success",
  "messages": [
    {
      "desc": "Example description"
    }
  ]
}