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

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 the same API key retries an identical cancellation request with the same client reference ID, the API returns 202 Accepted with the existing request's issuanceKey. If the request content or type differs, the API returns 409 Conflict with IDEMPOTENCY_CONFLICT. To check the status later, pass this value as clientReferenceId.

Required string length: 1 - 255
Pattern: \S
Bolta-Webhook-Test-Code
enum<string>

Use this header only to reproduce a cancellation failure webhook with a test key. Enter a cancellation failure code, and the API sends the corresponding failure webhook. Do not use this header in production (live). Cash receipt webhooks

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"