Skip to main content
POST
Send an clearing request

Authorizations

Authorization
string
header
required

HTTP Basic Auth. Credentials must carry the CAT2_API_ALL role.

Query Parameters

auditUser
string
required

Identifier of the user performing the action, used for audit logging.

Body

application/json

Clearing request

id
string
required

Unique authorization identifier (internal docId / ISO 8583 DE37).

Maximum string length: 18
clearingAmount
object
required

A monetary amount with currency.

card
object
required

Card used in the transaction.

merchantData
object
required

Merchant and acquirer data (ISO 8583 DE18, DE32, DE41–43).

transactionType
enum<string>
required

The transaction type.

  • ATM requires merchantCategoryCode: 6011
Available options:
RETAIL,
CASH,
ATM,
CREDIT,
UNIQUE,
P2P_CREDIT,
P2P_DEBIT,
BALANCE_INQUIRY
isFinal
boolean
default:true

Whether this is the final clearing request.

Response

Clearing processed

Clearing response

transactionId
string

Clearing transaction identifier.

filename
string

Name of the clearing file.