Cancel an invoice

POST /invoices/{foreign_id}/cancel

Cancel an invoice

cURL

curl --request POST \
  --url https://app.cryptoprocessing.com/api/v2/invoices/{foreign_id}/cancel/ \
  --header 'Content-Type: application/json' \
  --header 'X-Processing-Key: <api-key>' \
  --header 'X-Processing-Signature: <x-processing-signature>' \
  --data '{}'

200

Basic example

[]

Use this endpoint to cancel an invoice. You can only cancel invoices while they are still at the created, pending or processing stage. Invoices that have the confirmed or failed statuses cannot be cancelled.

Authorizations

X-Processing-Key · string · header · required

Your API key.

Headers

X-Processing-Signature · string · required

Hex-encoded HMAC-SHA512 signature of the request body, generated using your secret key.

Path Parameters

foreign_id · string · required

The unique identifier of the invoice you need to cancel.

Example:

"test_foreign_id_0344"

Body

application/json

The Content-Type: application/json header must be specified even though the request body has no fields.

This endpoint does not accept any request parameters, but you must still send an empty JSON object ({}) in the request body.

Response

200

application/json

OK