Cancel Cash Receipt
Fully cancel a cash receipt whose issuance processing was accepted. You can cancel it before its Hometax issuance is final, but not while the original request is PENDING. Partial cancellation is not supported. The API first returns 202 Accepted. Check the final result via webhook or the status API.
Authorizations
Base64-encode your API key and pass it. Enter the API key as the username and leave the password empty.
Headers
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.
1 - 255\SUse 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
INVALID_ISSUER, INVALID_RECIPIENT_IDENTIFIER, ORIGINAL_ISSUANCE_FAILED, CANCELLATION_TARGET_NOT_FOUND, UNKNOWN Path Parameters
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.
The cash receipt issuance key. Store the entire string as-is because its format and length may change.
"MRK98JGC5KOAEIPGK8U6UO05I3EAQPLI8OE78A3I"
The cash receipt issuance key. Store the entire string as-is because its format and length may change.
"MRK98JGC5KOAEIPGK8U6UO05I3EAQPLI8OE78A3I"
