This guide shows you how to delete a saved payee profile from the Payee Vault. Note that this operation cannot be reversed. See Delete a Payee in API Reference for field definitions.

Please note: This API resource is intended for a specific use case and requires integration through the Qualpay product team. To use this resource, please contact Qualpay Customer Support.

Prerequisites

1. Contact Qualpay Customer Support to configure your account for this resource.
2. Follow the Get Started guide to open your sandbox and get your test credentials.
3. See Authentication to format the credentials and generate your API token. (Alternatively, use the credentials as-is to test this endpoint with our 'Try It!' feature.)
4. Follow the steps in the Add a Payee guide to add at least one payee profile to the Payee Vault. Save the payee_id of the payee you wish to delete.

Implement

Write a DELETE request. For the request endpoint, append the payee_id value to the end of /platform/vault/payee/. The resulting endpoint reads /platform/vault/payee/payee_id, where the value replaces payee_id. See the url in the sample code below:

curl --request DELETE \
     --url https://api-test.qualpay.com/platform/vault/payee/999678 \
     --header 'accept: application/json' \
     --header 'authorization: Basic OjllZZZjMjFhMzFjMjMjFhMzFjMzjMjFhMzFjME2YWJjMTIz'

If you are sending this request on behalf of another merchant, append the merchant_id value to the end of the request, preceded by ?merchant_id=.

Example Request

Once configured, your request will resemble the following sample code:

curl --request DELETE \
     --url 'https://api-test.qualpay.com/platform/vault/payee/999678?merchant_id=210000000289' \
     --header 'accept: application/json' \
     --header 'authorization: Basic OjllZZZjMjFhMzFjMjMjFhMzFjMzjMjFhMzFjME2YWJjMTIz'

Integrate

Send your request to your customized endpoint. You will receive a response like this from the Qualpay server:

{
  "code": 0,
  "message": "Success",
  "data": {}
}

Check the code field in the request response: 0 confirms a successful transaction. If the value is something other than 0, check Platform API Response Codes in Reference.

See Delete a Payee in API Reference for response field definitions.

Test and Go Live

See our Test and Go Live guide to test your API integration and to start transacting with an active production account.