Skip to main content
GET
Query Payment

Headers

Abp-TenantId
string
required

Your unique Merchant ID assigned by CommercePay.

Authorization
string
required

Your API credentials used for authentication (typically a Bearer token).

cap-signature
string
required

A unique security hash used to verify the integrity of the request body. See Generate Signature for how to generate this.

Query Parameters

TransactionNumber
string

Unique CAP Transaction Number (Conditional: If it is query for specific transaction in either normal transaction or session transaction, then need pass the transaction number)

Maximum string length: 24
Timestamp
integer<int64>

new Date().getTime()

Example:

1621851652617

SessionNumber
string

Unique CAP Session Number (Conditional: If the query is query the session, then need pass the session number)

Maximum string length: 24

Response

Success

transactionNumber
string | null

Unique CAP transaction number

Maximum string length: 24
paymentSessionNumber
string | null

Unique CAP session number

Maximum string length: 24
referenceCode
string | null

Merchant Reference Code

Maximum string length: 50
status
enum<integer>

Payment Status: Refer on Appendix 3.1 Payment Status Code Table

Available options:
0,
1,
2,
3,
4,
5,
6,
7
currencyCode
string | null

Currency code with a 3-letter ISO 4217 standard code

Maximum string length: 3
Example:

"MYR"

amount
integer<int64>

This is Request Amount.

Example:

100

channelId
integer<int32>

Refer to endpoints in Get Channel List

providerTransactionNumber
string | null

Provider Transaction Number

creationTime
string<date-time>

Payment Transaction Creation Time

Example:

"2022-02-10T08:50:30.565Z"

remark
string | null

A description that additional information or clarify details for the transaction.

providerChannelId
string | null

An identifier that represents the payment provider channel

providerPaymentMethod
string | null

Provider Payment Method

providerErrorMessage
string | null

Provider Error Message

loyaltyType
enum<number>

[Conditional for Loyalty Payment]

1 = BCard

Available options:
1
redemptionPoint
integer<int64>

[Conditional for Loyalty Payment] Redemption Point.

redemptionAmount
integer<int64>

[Conditional for Loyalty Payment] Redemption Amount.

rewardPoint
integer<int64>

[Conditional for Loyalty Payment] Reward Point.

paidAmount
integer<int64>

[Conditional for Loyalty Payment] This is Paid Amount.

Example:

100

loyaltyRedemptionStatus
enum<number>

[Conditional for Loyalty Payment]

0 = Pending, 1 = Success, 2 = Failed, 3 = Void

Available options:
0,
1,
2,
3
loyaltyRewardStatus
enum<number>

[Conditional for Loyalty Payment]

0 = Pending, 1 = Success, 2 = Failed, 3 = Void

Available options:
0,
1,
2,
3