Card on File
Overview
You will have full control over when and how much to charge your customer.
Start Integrating
Step 1: Request for Payment Link
Endpoint
UAT
Production
POST https://member.uat.pay.axs.com.sg/api/hpp/v1/merchant/{merchantMid}/encryptedRequest Body
Schema
{
"data": "string (JWE compact serialization)"
}
| alg | PBES2-HS512+A256KW |
|---|---|
| enc | A256GCM |
| p2s | Salt (UUID) |
| p2c | Iteration (fixed value: 1000) |
| kid | Client ID |
Request Parameters
Parameters | Required | Remarks |
|---|---|---|
| name | Name of Service or Product used with this payment link. (1–30 characters) | |
| amount | Payment amount in cents. 1. Example: 100 = $1.00 2. Min $0.00 and max amount = $9,999,999.00 | |
| currencyCode | Payment currency (e.g., SGD) based on ISO 4217 Currently only support SGD. | |
| allowEdit | Fixed amount or allow payer to update the amount. Default Boolean : false | |
| billingType | Current payment type : ONE_TIME | |
| startDate | Start date and time when the payment link becomes active in UTC format (YYYY-MM-DDTHH:mm:ssZ) Default: UTC now | |
| endDate | End date and time when the payment link expires in UTC format (YYYY-MM-DDTHH:mm:ssZ). | |
| maxPaymentSuccessCount | Maximum allowed number of payments to accept or allow unlimited payments via payment link. Empty default unlimited. | |
| remarksEnabled | Whether the remarks field is enabled on the payment page. Default Boolean : true | |
| timezone | Timezone used for the link. Must be a valid IANA time zone identifier (e.g: Asia/Singapore). See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Default : Timezone from merchant detail | |
Response
https://{domain}/hpp/checkout/II4GNB19FFStep 2: Customer Input Card Details
Request Parameters
Parameters | Remarks |
|---|---|
| amount | Payment amount in cents. 1. Example: 100 = $1.00 2. Min $0.00 and max amount = $9,999,999.00 |
| merchantRef | Merchant's unique merchant reference. Max 40 characters. |
| terminalId | Merchant's input information. To be displayed in Merchant Portal. |
| webhookUrl | This URL will overwrite preset URL in Merchant Branding. |
| successUrl | This URL will overwrite preset URL in Merchant Branding. |
| failUrl | This URL will overwrite preset URL in Merchant Branding. |
Decrypt the JWE payload using the same secret key used for encryption in Step 1.
Webhook Parameters
Parameters | Required | Remarks |
|---|---|---|
| amount | Payment amount in dollar. Example: 101.01 | |
| currency | Payment currency (e.g., SGD) based on ISO 4217 Currently only support SGD. | |
| transactionRef | AXS' unique transaction reference. Example: 1448241333514969089 | |
| merchantRef | Merchant's unique merchant reference. | |
| status | Payment status: SUCCESS - Card tokenized successful. DECLINED - Card tokenization declined. | |
| responseCode | Payment response code. Example: 00 - payment successful 85 - card is valid to proceed Other codes - unsuccessful | |
| paymentScheme | Payment scheme. Available value: VISA / MASTERCARD | |
| paymentDateTime | Payment date time in (ISO 8601) standard. Example: 2025-12-10T09:14:01.201466Z | |
| token | Object list of token details. | |
| token.tokenId | Card token to be stored by merchant for future payment. | |
| token.scheme | VISA / MASTERCARD | |
| token.maskedPan | Masked card number. Example : 411111XXXXXX1111 | |
| token.expiry | Card expiry Example : 0139 |
Step 3: Charge the Saved Method
Endpoint
UAT
Production
POST https://member.uat.pay.axs.com.sg/api/hpp/v1/payment/payRequest Body
Schema
{
"data": "string (JWE compact serialization)"
}
| alg | PBES2-HS512+A256KW |
|---|---|
| enc | A256GCM |
| p2s | Salt (UUID) |
| p2c | Iteration (fixed value: 1000) |
| kid | Client ID |
Request Parameters
Parameters | Required | Remarks |
|---|---|---|
| token | Token of card received from webhook. | |
| paymentTokenParams | Object list of payment token parameters | |
| paymentTokenParams.amount | Payment amount in cents. 1. Example: 100 = $1.00 2. Min $0.01 and max amount = $9,999,999.00 | |
| paymentTokenParams.currency | Payment currency (e.g., SGD) based on ISO 4217 Currently only support SGD. | |
| paymentTokenParams.merchantRef | Merchant's unique merchant reference. Max 40 characters. | |
| paymentTokenParams.webhookUrl | This URL will overwrite preset URL in Merchant Branding. | |
| paymentTokenParams.terminalId | Merchant's input information. To be displayed in Merchant Portal. |
Response Parameters
Parameters | Remarks |
|---|---|
| paymentTransactionId | AXS internal payment trans Id. |
| status | SUCCESS / DECLINED |
| processorInformation | Object list of response from payment gateway. |
| processorInformation.approvalCode | Gateway approval code. |
| processorInformation.responseCode | Gateway response code. 00 - Success |
| processorInformation.retrievalReferenceNumber | Gateway RRN |
| processorInformation.merchantReference | From merchantRef parameter |
| processorInformation.transactionReference | AXS unique transaction reference that can be found in Merchant Portal. Example: 1452945254357237761 |
| processorInformation.cardholderMessage | Card holder message. Can be empty. |
| processorInformation.maskedPan | Masked card number. Example : 411111XXXXXX1111 |
| processorInformation.expiry | Card expiry. Can be empty. |
| processorInformation.issuerCountryAlpha | Issuer Country. Example : POL |
| processorInformation.issuerCountryNumeric | Issuer Country Code. Example: 616 |
| processorInformation.brand | VISA / MASTERCARD |
| processorInformation.cardType | DEBIT / CREDIT |