Deleting Payments

HTTP DELETE to void a payment from Branta.

Payments that are registered with Branta automatically expire after the TTL seconds specified upon creation. If a Payment must be invalidated before TTL, the payment can be deleted.

(This endpoint deletes all payments with the given address for your API Key, in case redundant addresses have been added.)

Delete a payment

Delete a payment by address.

delete

/payments/{id}

Path parameters

idstringrequired

The unique identifier string of the payment.

Header parameters

API_KEYstringrequired

The API_KEY is required to authorize the request. This key is unique to each client and must be included in the header of every request. Failure to provide a valid API_KEY will result in an unauthorized error.

Make sure to keep your api_key confidential.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://staging.branta.pro/v1/payments/{id}' \
  --header 'API_KEY: text'

204

401

404

204

No body

Payment deleted successfully.