iDEAL Online
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.CreatePayments | Required |
time | Long | timestamp | Required |
- Parameter
Parameter | Type | Description | Required |
---|---|---|---|
pay_method | String | online | Required |
sub_pay_method | String | iDEAL ,iDEAL Fast Checkout | Required |
order_id | String | order id from Merchant | Required |
amount | String | format in cents: € 24.99 should be 24.99, the min amount is EUR 0.10 or CNY 1 | Required |
currency | String | EUR | Required |
bic | String | payer bank code | Optional |
description | String | order description | Required |
demo | String | custom field | Optional |
timeout | String | value 0 means 1440 minutes | Optional |
redirect_url | String | the redirect URL after payment is completed | Optional |
notify_url | String | asynchronous notification url | Required |
Signature:
Lexicographical sequence and URL key-value format new string
"amount=1¤cy=EUR&bic=ABNANL2A&demo=test&description=YabandPay test&method=v3.CreatePayments¬ify_url=https://www.yabandpay.com/notify&order_id=2024659859874654848&pay_method=online&redirect_url=https://www.yabandpay.com&sub_pay_method=iDEAL&time=1555498137&timeout=0&user=016683"
Use stringA and secret_key to get stringSign
Get Signature:
"e297397410a1e604f69a192d49e116e2d925801a2cfba2911aef56668a31e6d3"
Example Request:
{
"user": "016683",
"sign": "e297397410a1e604f69a192d49e116e2d925801a2cfba2911aef56668a31e6d3",
"method": "v3.CreatePayments",
"time": "1555498137",
"data": {
"description": "YabandPay test",
"timeout":"0",
"pay_method": "online",
"sub_pay_method": "iDEAL",
"bic": "ABNANL2A",
"order_id": "2024659859874654848",
"amount": "1",
"currency": "EUR",
"redirect_url": "https://www.yabandpay.com",
"notify_url": "https://www.yabandpay.com/notify",
"demo": "test"
}
}
Example Response:
{
"status": true,
"code": "200",
"data": {
"order_id": "2024659859874654848",
"trade_id": "824f354c-e60f-bcd3-48a4-13c217be1b78",
"amount": "1.00",
"currency": "EUR",
"settlement_amount": "1.00",
"settlement_currency": "EUR",
"exchange_rate": "1",
"bic": "ABNANL2A",
"url": "https://pay.yabandpay.com/payments/callback/order/ODI0ZjM1NGMtZTYwZi1iY2QzLTQ4YTQtMTNjMjE3YmUxYjc4",
"state": "processing"
},
"message": ""
}
[!TIP|style:flat]
Parameter bic description
From July 1, 2024, according to iDEAL requirements,
bic
must be empty, otherwise it will be a violation.Parameter sub_pay_method description
Both
iDEAL
andiDEAL Fast Checkout
are payment methods of iDEAL. After calling the API, we will return a URL for the jump to the payment page.iDEAL Fast Checkout
aims to simplify the shopping checkout process for consumers, reducing the information to be filled in and the operation steps required during checkout. This can improve the shopping experience and conversion rate. The entire process is smooth and fast, enhancing the shopping experience. After the user's payment is successful, please call Order Query to obtaincheckout_data
, which containscustomer
,billingAddress
andshippingAddress
.
More Information:
Return results:
On a successful API call, the response will be
"status": true
.On a failed API call, the response will be
"status": false
.
We strongly recommend using both Order Query and Asynchronous Notification simultaneously to synchronize and update payment status, ensuring real-time accuracy of payment information.
Result/Error codes:
Status | Code | Message |
---|---|---|
true | 200 | Success |
fales | -1000 | Internal error |
fales | -3001 | Required field is missing |
fales | -403 | The signature Error |
fales | -4011 | Not support the payment method |