Skip to main content
POST
Simulate transaction event in sandbox environment

Authorizations

Authorization
string
header
required

Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>

Body

application/json
payment_method_id
string
required

Unique identifier of the payment method used.

Example:

"7f754378-dd84-4a9a-b1ce-0646bb769c29"

status
enum<string>
required
Available options:
APPROVED,
UPDATED,
VOIDED,
CAPTURED,
REFUNDED
Example:

"APPROVED"

event_id
string

Unique identifier of the event.

Example:

"e2806932-5f1b-4518-8b15-156d773e9496"

transaction_id
string

Unique identifier of the transaction. Required to VOID, UPDATE, CAPTURE, or REFUND a transaction

Example:

"e2806932-5f1b-4518-8b15-156d773e9496"

amount
integer

Amount of the transaction in the smallest currency unit (e.g., cents for USD).

Example:

5000

currency
string

The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")

Example:

"USD"

authorization_code
string | null

Code used to authorize the transaction.

Example:

"645432"

network_transaction_id
string | null

Unique transaction identifier assigned by the payment network.

Example:

"txn-789456"

purchase_method
enum<string> | null

How the purchase was completed.

Available options:
CHIP,
CONTACTLESS,
KEYEDIN,
ONLINE,
SWIPE,
QRCODE,
OCR,
UNKNOWN
Example:

"CHIP"

merchant
object

Response

Transaction event created successfully

transaction_id
string

Unique identifier of the transaction

Example:

"E777214A-2D11-4CAD-9E8F-E1BD71D9FE67"

event_id
string

Unique identifier of the event generated, matches the event_id in the transaction event notification

Example:

"E777214A-2D11-4CAD-9E8F-E1BD71D9FE67"

status
enum<string>
Available options:
APPROVED,
UPDATED,
VOIDED,
CAPTURED,
REFUNDED
Example:

"APPROVED"