Skip to main content

Transaction APIs

Get list of transactions​

POST /abc/v1/transaction/query

Query Card Transaction Flows (Paginated)

Request Headers​

X-API-Key
string
example
{apiKey}
X-Timestamp
integer
example
{{Timestamp}}
X-Nonce
string
example
{{Nonce}}
X-Signature
string
example
{{Signature}}
Content-Type
string
example
application/json

Request Body​

Data model: OpenTransactionPageRequest

pageNo
integerRequired
Description
Page number, starting from 1
Range：≥1
Default：1
Example：1
pageSize
integerRequired
Description
Items per page
Range：1–200
Default：10
Example：10
transactionNo
string
Description
transaction number

Request Example

{ "pageNo": 1, "pageSize": 10 }

Successful Response​

Data model: CommonResultPageResultOpenTransactionResponse

Response Fields​

code
integer
Description
Error code
msg
string
Description
Human-readable error message
View child fields
total
integer (int64)
Description
Total
list
array<object (OpenTransactionResponse)>
Description
Data

Get transaction details​

POST /abc/v1/transaction/detail

Get a Single Transaction Details by Transaction Number

Request Headers​

X-API-Key
string
example
{apiKey}
X-Timestamp
integer
example
{{Timestamp}}
X-Nonce
string
example
{{Nonce}}
X-Signature
string
example
{{Signature}}
Content-Type
string
example
application/json

Request Body​

Data model: OpenTransactionDetailRequest

transactionNo
stringRequired
Description
transaction number

Successful Response​

Data model: CommonResultOpenTransactionResponse

Response Fields​

code
integer
Description
Error code
msg
string
Description
Human-readable error message
View child fields
fieldTypeRequiredDescriptionExample / Default
transactionNostringNotransaction number-
cardNostringNocard number-
currencystringNoCurrency (USD/GBP/EUR, etc.)-
countryRegionstringNocountry/region-
transactionTypeintegerNoTransaction type code used by programs to identify the transaction type. Valid values are 1–8: 1 = Authorization; 2 = Auth Reversal; 3 = Reversal; 4 = Clearing; 5 = Refund; 6 = Chargeback; 7 = Dispute; 8 = Fees.-
transactionTypeDescstringNoHuman-readable transaction type description for page display and user reading. This field corresponds to transactionType and returns the corresponding English type name and meaning, such as Authorization.-
transactionAmountnumberNotransaction amount-
crossBorderFeenumberNocross-border fee-
subAccountAvailablenumberNosub accountavailable amount-
statusintegerNo-Authorization includes Approved: the authorization succeeded and funds were held but not actually debited; Declined: the authorization was declined; Expired: the authorization timed out without clearing and the funds were automatically released; Partially Approved: only part of the requested amount was approved. Auth Reversal includes Succeeded: the reversal succeeded and the held funds were released; Failed: the reversal failed. Reversal includes Succeeded: the reversal completed, the original cleared transaction was reversed, and the funds were credited back in the original amount; Pending: the reversal message was sent and the counterparty system response is pending; Failed: the reversal failed. Clearing / Capture includes Succeeded: clearing completed and the funds were actually debited; No-Auth Clearing: clearing completed without a corresponding authorization record. Refund includes Pending: the refund was initiated and is awaiting clearing; Succeeded: the refund was credited and the funds were returned; Partial Refund: only part of the transaction amount was refunded; Failed: the refund failed. Chargeback includes Initiated: the chargeback was submitted to the card scheme; Pending Merchant Response: the merchant is expected to submit supporting evidence; Won: the chargeback was upheld and the funds were debited; Lost: the chargeback was not upheld and the funds were not returned; In Arbitration: the case entered the card scheme arbitration stage; Reversed: the chargeback was reversed. Dispute includes Submitted: the dispute was submitted; Pending: the dispute is being processed; Resolved: the dispute was resolved internally without escalation to a chargeback; Won: the dispute was upheld and the funds were returned; Lost: the dispute was not upheld and the funds were not returned; Closed: the dispute was closed and archived; Cancelled: the dispute was withdrawn by the cardholder. Fees includes Charged: the fee was deducted; Pending: the fee is pending settlement; Waived: the fee was waived; Refunded: the fee was returned.-
transactionTimeUtstringNotransaction time (UTC time)-
transactionTimeMtstringNotransaction time (local time)-
subAccountIdstringNosub account ID-
budgetNamestringNobudgetname-
merchantDescstringNomerchant description-

3DS Challenge​

POST /abc/v1/3ds-challenge/challenge

Submit a 3DS Challenge Decision (Check the Status Before Submitting)

Request Headers​

X-API-Key
string
example
{apiKey}
X-Timestamp
integer
example
{{Timestamp}}
X-Nonce
string
example
{{Nonce}}
X-Signature
string
example
{{Signature}}
Content-Type
string
example
application/json

Request Body​

Data model: OpenThreeDsChallengeRequest

acsTransactionId
stringRequired
Description
3DS authentication ID (received through a push notification or email)
Example / Default
8cc2859e-986c-40c1-a22c-26d653bd3b67
approve
booleanRequired
Description
Whether to approve: true=approve, false=reject
Example / Default
True

Successful Response​

Data model: CommonResultOpenThreeDsChallengeResponse

Response Fields​

code
integer
Description
Error code
msg
string
Description
Human-readable error message
View child fields
id
string
Description
3DS authentication ID (returned unchanged)
Example / Default
8cc2859e-986c-40c1-a22c-26d653bd3b67
state
string
Description
Processing result: DONE_ACCEPT (approved) / DONE_REJECT (rejected) / LOCKED (handled by another channel) / EXPIRED (expired or unauthorized)
Example / Default
DONE_ACCEPT