Skip to main content
POST
Cancel Cash Receipt

Authorizations

Authorization
string
header
required

Base64-encode your API key and pass it. Enter the API key as the username and leave the password empty.

Headers

Supplier-Key
string
required

Enter the identification key of the supplier used for the original issuance. Glossary | Authentication guide

Bolta-Client-Reference-Id
string
required

Enter a client reference ID between 1 and 255 characters that differs from the issuance request. The API uses this value as the cancellation request's idempotency key. If you retry with the same value and an identical cancellation request, the API returns the existing result. If the request content or type differs, the API returns 409 Conflict. To check the status later, pass this value as clientReferenceId.

Bolta-Webhook-Test-Code
enum<string>

Use this header only to reproduce a failure webhook with a test key. Do not use this header in production (live).

Available options:
INVALID_ISSUER,
INVALID_RECIPIENT_IDENTIFIER,
ORIGINAL_ISSUANCE_FAILED,
CANCELLATION_TARGET_NOT_FOUND,
UNKNOWN

Path Parameters

issuanceKey
string
required

Enter the original cash receipt's issuanceKey from the issuance response.

Response

The API accepted the cancellation request. Check the final result via webhook or the status API.

issuanceKey
string
required

The cash receipt issuance key. Store the entire string as-is because its format and length may change.

Example:

"MRK98JGC5KOAEIPGK8U6UO05I3EAQPLI8OE78A3I"

originalIssuanceKey
string
required

The cash receipt issuance key. Store the entire string as-is because its format and length may change.

Example:

"MRK98JGC5KOAEIPGK8U6UO05I3EAQPLI8OE78A3I"