post https://sandbox.xfers.io/api/v4/payment_methods/
Static PayNow QR
The Static PayNow QR payment method allows you to assign each user/customer with their own unique PayNow QR code, which accepts an open amount.
Parameters | Required? | Type | Description |
---|---|---|---|
referenceId | Mandatory | String | This is used for idempotency and should typically be a "customer id" or "wallet id" on your platform. |
bankShortCode | Optional | String | Available option: "fazz". |
id | Optional | String | id is retrieved from the Customer Profile API's response id. Mandatory if you're considered to be in a high-risk industry. |
Example of Static PayNow QR payment method request
# POST api/v4/payment_methods/paynow
{
"data": {
"relationships": {
"customerProfile": {
"data": {
"id": "brenda-test123"
}
}
},
"attributes": {
"referenceId": "unique_reference_123",
"bankShortCode": "fazz"
}
}
}
Example of Static PayNow QR payment method response
# Response: 201 Created
{
"data": {
"id": "payment_method_bc35dea3-9ee5-4c7e-ad70-aa8e21276371",
"type": "paynow",
"attributes": {
"referenceId": "unique_reference_123",
"instructions": {
"proxyType": "VPA",
"proxyValue": "UEN202204250RXFR#FAZZ",
"qrCodeDisplayImage": "iVBORw0KGgoAAAANSUhEUg..."
}
}
}
}
Virtual Account (Unlimited)
The Unlimited Virtual Account (VA) payment method allows you to assign each customer their own unique VA, which accepts an open amount.
Parameters | Required? | Type | Description |
---|---|---|---|
referenceId | Mandatory | String | This is used for idempotency and should typically be a "customer id" or "wallet id" on your platform. |
id | Optional | String | id is retrieved from the Customer Profile API's response id. Mandatory if you're considered to be in a high-risk industry. |
bankShortCode | Mandatory | String | The bank code used for creating the virtual account Payment Method. This should clearly identify a bank in the region that you want your customer to make a transfer to. This should usually be the bank that the end-customer will be making a transfer from. Available options: "FAZZ" or "CIMB". |
Example of Unlimited VA payment method request.
# POST api/v4/payment_methods/virtual_bank_accounts
{
"data": {
"relationships": {
"customerProfile": {
"data": {
"id": "customer_profile_ff9a2945-5f58-4cd3-ac6e-90ee4361bf1e"
}
}
},
"attributes": {
"referenceId": "unique_refff88",
"bankShortCode": "fazz"
}
}
}
Example of Unlimited VA payment method response.
# Response: 201 Created
{
"data": {
"id": "payment_method_1228d6a2-a0f5-4613-bc02-7a0164a5fc22",
"type": "virtual_bank_account",
"attributes": {
"referenceId": "unique_refff88",
"instructions": {
"bankShortCode": "FAZZ",
"bankName": "Xfers Pte Ltd",
"accountNo": "344383189127"
}
}
}
}