Skip to main content
GET
Retrieve Cash Receipt Status

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.

Query Parameters

clientReferenceId
string
required

The Bolta-Client-Reference-Id used in the issuance or cancellation request

Response

Processing status of cash receipt issuance or cancellation

clientReferenceId
string
required

The client reference id (Bolta-Client-Reference-Id)

issuanceKey
string
required

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

Example:

"MRK98JGC5KOAEIPGK8U6UO05I3EAQPLI8OE78A3I"

type
enum<string>
required

Request type. ISSUE: issuance, CANCELLATION: cancellation

Available options:
ISSUE,
CANCELLATION
status
enum<string>
required

Processing status. PENDING/REQUEST_SUCCESS mean in progress, ISSUED/CANCELED mean success, and REQUEST_FAILURE/ISSUE_FAILED/CANCEL_FAILED mean failure. EXTERNALLY_CANCELED is a terminal status for a receipt canceled outside Bolta.

Available options:
PENDING,
REQUEST_SUCCESS,
REQUEST_FAILURE,
ISSUED,
ISSUE_FAILED,
CANCELED,
CANCEL_FAILED,
EXTERNALLY_CANCELED
message
string
required

Processing status message

originalIssuanceKey
string | null

Issuance key of the original cash receipt in a cancellation request

Example:

"MRK98JGC5KOAEIPGK8U6UO05I3EAQPLI8OE78A3I"

cashReceiptApprovalNumber
string | null

The cash receipt approval number provided after successful issuance

failure
object | null

The failure details provided when processing fails