Credit Card
Available: authorization and sales
This payment method uses a Hosted Payment Page, meaning YabandPay hosts the checkout process. Consumers enter their card information on the YabandPay checkout page to complete the payment.
Only Visa and Mastercard are accepted.
[!TIP|style:flat]
The pre-authorization is valid for 30 days. After 30 days, the pre-authorization order will automatically expire.
API URL:https://mapi.yabandpay.com/Payments
Method:POST
POST data type:Json
Parameter | Type | Description | Required |
---|---|---|---|
user | String | the UID of cashier account | Required |
sign | String | signature | Required |
method | String | v3.CreateCardPayments | Required |
time | Long | timestamp | Required |
- Parameter
Parameter | Type | Description | Required |
---|---|---|---|
pay_method | String | online | Required |
sub_pay_method | String | Credit Card | Required |
operate | String | 1.Sales 2.Authorisation; | Required |
order_id | String | order id from Merchant | Required |
3ds_initiate | String | 01. Enable 3DS verification; 02. Disable 3DS verification | Required |
amount | String | format in cents: € 24.99 should be 24.99, the min amount is EUR 1.00 | Required |
currency | String | ISO 4217, For example EUR, CHF | Required |
description | String | order description | Required |
demo | String | custom field | Required |
timeout | String | value 0 means 1440 minutes | Required |
redirect_url | String | the redirect URL after payment is completed | Required |
notify_url | String | asynchronous notification url | Required |
request_id | String | The request ID must be unique. It is recommended to use a combination of at least 24 digits and letters. | Required |
Signature:
Lexicographical sequence and URL key-value format new string
"3ds_initiate=01&amount=1¤cy=EUR&description=test&method=v3.CreateCardPayments¬ify_url=https://www.yabandpay.com/notify&operate=2&order_id=203040950640690239603690&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=x7f6dketj52aq5809w5t0rjhp56vmwnz&sub_pay_method=Credit Card&time=1720683857&timeout=0&user=016683"
Use stringA and secret_key to get stringSign
Get Signature:
"3a19a99325e175a6d681616be08c2d4f4890578d1ad3602f4f5853a4a606212b"
Example Request:
{
"user": "016683",
"sign": "3a19a99325e175a6d681616be08c2d4f4890578d1ad3602f4f5853a4a606212b",
"method": "v3.CreateCardPayments",
"time": 1720680417,
"data": {
"description": "test",
"3ds_initiate": "01",
"timeout": "0",
"pay_method": "online",
"sub_pay_method": "Credit Card",
"operate": "1",
"order_id": "203040950640690239603690",
"amount": "1",
"currency": "EUR",
"redirect_url": "https://www.yabandpay.com/redirect_url",
"notify_url": "https://www.yabandpay.com/notify",
"request_id": "tscqf7ki76o7aem4z1yl1xs72f89fptl"
}
}
Example Response:
{
"status": true,
"code": "200",
"data": {
"order_id": "203040950640690239603690",
"trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
"amount": "1.00",
"currency": "EUR",
"settlement_currency": "EUR",
"exchange_rate": "1",
"url": "https://partner.yabandpay.com/payments/callback/order/MTYwODk5ZjMtZjZkOS1hOGQ4LWFiNWItODJlYWNkYWI5YzVi",
"state": "processing"
},
"message": "",
"response_id": "202407111544200649155078"
}
More Information:
Return results:
If the payment cancellation succeeds, it returns
"status": true
.If the payment cancellation fails, it returns
"status": false
.
You need to redirect to the returned url
. After the user enters their card information and completes the payment at this url
, they will be redirected back to the redirect_url
. You can also check the order status by calling Query payment or wait for an asynchronous notification. If the order status state
is paid
, the payment is successful. If the order status state
is authorized
, the authorisation is successful.
Result/Error codes:
Status | Code | Message |
---|---|---|
true | 200 | |
fales | -1000 | internal error |
fales | -403 | The signature Error |
fales | -2001 | The user not exist |
fales | -3001 | Required field is missing |
fales | -4118 | Incorrect request ID |