Payment API
Default Payment Request Table
| Field Name | Data Description | Type | Min | Max | Example | Required |
|---|---|---|---|---|---|---|
| amount | Float data type. Accepted as a number or a numeric string, e.g. 500 or "500". | NU | 1 | – | 50000.00 | yes |
| callbackUrl | Url where payment callback will be sent | URL | – | – | https://example.com/callback | yes |
| country | ISO 3166-1-alpha-2 | CH | 2 | 2 | PK | yes |
| currency | Alphabetic currency code, e.g. INR | CH | 3 | 3 | PKR | yes |
| Valid email format | AN | 6 | 120 | name@email.com | yes | |
| ip | Customer’s IP | IP | – | – | 192.0.2.1 | yes |
| method | Methods supported, see the samples below. | CH | – | – | WALLETS | yes |
| orderId | Merchant Order ID | AN | 1 | 50 | abc123456 | yes |
| returnUrl | Url to redirect after payment | URL | – | – | https://example.com/return | yes |
| traffic | Traffic type. Options: FTD, TRUSTED | CH | 3 | 7 | TRUSTED | yes |
Generic Payment Request Body & Response Samples
{
"amount": "5000",
"country": "AR",
"currency": "ARS",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"dni": "65476574"
}
}{
"amount": "5000",
"country": "AR",
"currency": "ARS",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "MERCADO_PAGO",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"dni": "65476574"
}
}{
"amount": "20",
"country": "AU",
"currency": "AUD",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "PAY_ID",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"accountNumber": "35465345543453",
"lastName": "Doe",
"mobileNumber": "0412123123",
"name": "John"
}
}{
"amount": "100",
"country": "AZ",
"currency": "AZN",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"bankCode": "UNIB",
"lastName": "Doe",
"name": "John"
}
}{
"amount": "300",
"country": "BD",
"currency": "BDT",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BKASH",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "01888123456",
"name": "John"
}
}{
"amount": "300",
"country": "BD",
"currency": "BDT",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "NAGAD",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "01888123456",
"name": "John"
}
}{
"amount": "300",
"country": "BD",
"currency": "BDT",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "ROCKET",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "01888123456",
"name": "John"
}
}{
"amount": "10",
"country": "BR",
"currency": "BRL",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "PIX",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"pixAccount": "12345678900"
}
}{
"amount": "10000",
"country": "ID",
"currency": "IDR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "DANA",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "6281234567890",
"name": "John"
}
}{
"amount": "10000",
"country": "ID",
"currency": "IDR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "QR_CODE",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "6281234567890",
"name": "John"
}
}{
"amount": "10000",
"country": "ID",
"currency": "IDR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "VIRTUAL_ACCOUNT",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "6281234567890",
"name": "John"
}
}{
"amount": "500",
"country": "IN",
"currency": "INR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "919876543210",
"name": "John"
}
}{
"amount": "500",
"country": "IN",
"currency": "INR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "PAY_TM",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "919876543210",
"name": "John"
}
}{
"amount": "500",
"country": "IN",
"currency": "INR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "UPI",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "919876543210",
"name": "John",
"pin": "user_1"
}
}{
"amount": "1000",
"country": "JP",
"currency": "JPY",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"name": "John"
}
}{
"amount": "1000",
"country": "JP",
"currency": "JPY",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "KONBINI",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"name": "Taro",
"lastName": "Yamada"
}
}{
"amount": "1000",
"country": "JP",
"currency": "JPY",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "PAYEASY",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"name": "Taro",
"lastName": "Yamada"
}
}{
"amount": "100",
"country": "KE",
"currency": "KES",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "MOBILE_MONEY",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"name": "John"
}
}{
"amount": "10000",
"country": "KR",
"currency": "KRW",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"accountNumber": "79823570294",
"bankCode": "OSB",
"lastName": "Doe",
"mobileNumber": "01095786574",
"name": "John"
}
}{
"amount": "10000",
"country": "KR",
"currency": "KRW",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "VIRTUAL_ACCOUNT",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"accountNumber": "79823570294",
"bankCode": "OSB",
"lastName": "Doe",
"mobileNumber": "01095786574",
"name": "John"
}
}{
"amount": "10",
"country": "MY",
"currency": "MYR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "601123456789",
"name": "John"
}
}{
"amount": "10",
"country": "MY",
"currency": "MYR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "QR_CODE",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "601123456789",
"name": "John"
}
}{
"amount": "100",
"country": "NG",
"currency": "NGN",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"name": "John"
}
}{
"amount": "100",
"country": "PH",
"currency": "PHP",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "GOTYME",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"mobileNumber": "09151037552"
}
}{
"amount": "100",
"country": "PH",
"currency": "PHP",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "GRABPAY",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"mobileNumber": "09151037552"
}
}{
"amount": "100",
"country": "PH",
"currency": "PHP",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "G_CASH",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"mobileNumber": "09151037552"
}
}{
"amount": "100",
"country": "PH",
"currency": "PHP",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "MAYA",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"mobileNumber": "09151037552"
}
}{
"amount": "100",
"country": "PH",
"currency": "PHP",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "QR_CODE",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"mobileNumber": "09151037552"
}
}{
"amount": "1000",
"country": "PK",
"currency": "PKR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "EASY_PAISA",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "03123123123",
"name": "John"
}
}{
"amount": "1000",
"country": "PK",
"currency": "PKR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "JAZZ_CASH",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"mobileNumber": "03123123123",
"name": "John"
}
}{
"amount": "1000",
"country": "PK",
"currency": "PKR",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "RAAST",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"mobileNumber": "03123123123"
}
}{
"amount": "100",
"country": "SG",
"currency": "SGD",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"bankCode": "DBS",
"lastName": "Doe",
"name": "John"
}
}{
"amount": "100",
"country": "SG",
"currency": "SGD",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "PAYNOW",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"name": "John"
}
}{
"amount": "100",
"country": "TH",
"currency": "THB",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"name": "John"
}
}{
"amount": "100",
"country": "TH",
"currency": "THB",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "PROMPT_PAY",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"lastName": "Doe",
"accountNumber": "35465345543453",
"name": "John"
}
}{
"amount": "100",
"country": "TR",
"currency": "TRY",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "VIP_HAVALE",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return",
"map": {
"dob": "01-01-1970",
"lastName": "Doe",
"mobileNumber": "905476476455",
"name": "John",
"tin": "12345678911"
}
}{
"amount": "50000",
"country": "VN",
"currency": "VND",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "BANK_TRANSFER",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return"
}{
"amount": "50000",
"country": "VN",
"currency": "VND",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "MOMOPAY",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return"
}{
"amount": "50000",
"country": "VN",
"currency": "VND",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "PHONE_CARD",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return"
}{
"amount": "50000",
"country": "VN",
"currency": "VND",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "QR_CODE",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return"
}{
"amount": "50000",
"country": "VN",
"currency": "VND",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "VIETTELPAY",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return"
}{
"amount": "50000",
"country": "VN",
"currency": "VND",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "VIRTUAL_ACCOUNT",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return"
}{
"amount": "50000",
"country": "VN",
"currency": "VND",
"email": "email@test.com",
"ip": "192.0.2.1",
"method": "ZALOPAY",
"orderId": "abc123456",
"traffic": "TRUSTED",
"callbackUrl": "https://example.com/callback",
"returnUrl": "https://example.com/return"
}Generic Payment Response Sample
{
"paymentUrl": "https://example.com/payment",
"status": "PENDING",
"message": "Transaction is being processed",
"id": "912z-1zs4-acvb-1bre3",
"orderId": "abc123456"
}Additional Payment Data Fields:
The payment request “map” field contains possible additional parameters, which are provider dependent. If the parameters are missing, the required values will be asked (via web form) from the customer. The exception is accountNumber: for the methods that require it, a request without it is rejected.
| Field Name | Data Description | Type | Min | Max | Example | Required |
|---|---|---|---|---|---|---|
| accountNumber | Customer’s account identifier: a bank account number, an email or similar, depending on country and method (AUD / PAY_ID takes either). Required for AUD / PAY_ID, KRW / BANK_TRANSFER, KRW / VIRTUAL_ACCOUNT and THB / QR_CODE; for these methods a request without it is rejected. | CH | 1 | – | 35465345543453 or customer@example.com | yes |
| address | Customer address | CH | 1 | – | Testshington Street | no |
| bankCode | Customer bank code | CH | 1 | – | DBS | yes |
| city | Customer city | CH | 1 | – | City | no |
| dni | Customer’s national identity number (DNI) | CH | 1 | – | 65476574 | yes |
| dob | Customer’s Date of Birth | AN | 10 | 10 | 1990-12-21 | no |
| lastName | Customer last name | CH | 1 | – | Doe | yes |
| midId | For technical flexibility purposes | NU | 1 | – | 123 | no |
| mobileNumber | Customer mobile number | CH | 1 | – | 5467756764 | yes |
| name | Customer first name | CH | 1 | – | John | yes |
| pin | Merchant’s own customer identifier, e.g. a user ID | CH | 1 | – | user_1 | no |
| pixAccount | Customer’s PIX key | CH | 1 | – | 12345678900 | yes |
| postalCode | Customer postal code | CH | 1 | – | 435645 | no |
| state | Customer state | CH | 1 | – | ST | no |
| tin | Tax Identification Number | NU | 9 | 11 | 12345678910 | no |
Payment API Response Fields
| Description | Format | Explanation |
|---|---|---|
| id | String | System Transaction ID |
| message | String | Payment response message |
| paymentUrl | String | The payment URL you need to serve to customer |
| status | String | Transaction status |
| orderId | String | Merchant Order ID |