Sale Request
POST
/api/v1/sale
Endpoint
Live
Sandbox
Webhook and Return URL
Webhook
Merchant structure and payment result will be posted in JSON format.
{
"merchant": {
"id": "M-01K746TGTZ4Y5YJG5EPF3DE057",
"site-id": "S-01K746TJSGRJBZ2BK6MPX54AN8",
"track-id": "408-867-5309"
},
"result": {
"status": "approved",
"code": "0",
"message": "Test 3DS Card OK.",
"transaction-id": "T-99JHTG4PVZ8GRCDM4PVZ8GRCDM",
"descriptors": "3ds DESC"
}
}Return URL
Query Parameters are added to URL.
| Parameter | Description |
|---|---|
| result.transaction-id | Transaction ID |
| result.message | Result Message |
| result.status | Result Code |
| merchant.track-id | Track ID given on merchant structure |
About Sandbox: Sale
Merchant and Site for Sandbox
for USD
for JPY
Test Cards
| Brand | Card Number |
|---|---|
| Visa | 4242424242424242 |
| Master | 5105105105105100 |
| CVV | Expected Result |
|---|---|
| 123 | Approved |
| 456 | Declined |
| 789 | 3D-Secure ( Approved ) |
| 987 | 3D-Secure ( Declined ) |
| 999 | Error |
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/sale' \
--header 'Content-Type: application/json' \
--data-raw '{
"merchant": {
"id": "M-01K746TGTZ4Y5YJG5EPF3DE057",
"site-id": "S-01K746TJSGRJBZ2BK6MPX54AN8",
"password": "hwOmLFLWhbty",
"track-id": "408-867-5309",
"return-url": "https://example.com/return-url"
},
"billing": {
"currency-code": "USD",
"amount": 12.34,
"product-desc": "Product Description",
"card": {
"holder": "John Doe",
"number": "4242424242424242",
"exp-y": "2030",
"exp-m": "12",
"cvv": "123"
}
},
"customer": {
"email": "john@example.com",
"ip": "123.123.123.123",
"country": "US",
"zip": "10001",
"state": "State",
"city": "City",
"address": "Address",
"phone": "+17182222222"
}
}'Response Response Example
200 - OK
{
"type": "valid",
"merchant": {
"id": "M-01K746TGTZ4Y5YJG5EPF3DE057",
"site-id": "S-01K746TJSGRJBZ2BK6MPX54AN8",
"track-id": "408-867-5309"
},
"result": {
"status": "approved",
"code": 0,
"message": "resultMessage",
"transaction-id": "T-99JHTG4PVZ8GRCDM4PVZ8GRCDM",
"descriptors": [
"PAYMENT-DESC",
"PAYMENT-DESC2"
],
"redirect-url": "https://example.com/3ds"
}
}