Skip to main content
POST
Process 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.

Body

application/json
type
enum<number>
required

1 = PreAuth, 2 = FullPayment, 3 = PartialPayment, 4 = Verify

Available options:
1,
2,
3,
4
transactionNumber
string
required

Unique CAP Transaction Number

Maximum string length: 24
amount
integer
required

Please take note: The Amount parameter only accepts integer units. For example, 1000 is equivalent to 10.00 for the backend.

Invalid Format: 1,000.00

Example:

100

channelDetails
object

[Optional]

savePayment
boolean | null

[Conditional for Tokenize Payment] To save user info for subsequent payment

LastPayment
boolean | null

Response

200 - application/json

Success

status
enum<integer>

Payment Status: Refer on Appendix 3.1 Payment Status Code Table

Available options:
0,
1,
2,
3,
4,
5,
6,
7
type
enum<number>

1 = PreAuth, 2 = FullPayment, 3 = PartialPayment, 4 = Verify

Available options:
1,
2,
3,
4
transactionNumber
string

Unique CAP Transaction Number

Maximum string length: 24
partialTransactionNumber
string | null
amount
integer

Please take note: The Amount parameter only accepts integer units. For example, 1000 is equivalent to 10.00 for the backend.

Invalid Format: 1,000.00

Example:

100