API REFERENCE
CardCheck
Parâmetros
| Parameter | Type | Descrição | Obrigatório |
|---|---|---|---|
| data.pay_method | string | online | ✓ |
| data.sub_pay_method | string | CardCheck | ✓ |
| data.operation | string | 3 | ✓ |
| data.order_id | string | 商户的订单ID | ✓ |
| data.description | string | 订单描述 | ✓ |
| data.form_type | string | 返回的url类型,默认01。 01.completed, 02.iframe | — |
| data.demo | string | 自定义字段 | — |
| data.timeout | string | 过期时间单位分钟(0-1440) | ✓ |
| data.redirect_url | string | 支付完成后跳转地址 | — |
| data.notify_url | string | 支付完成后异步通知地址 | ✓ |
| data.request_id | string | 请求id需保持唯一,建议24以上位数字+字母 | ✓ |
Inicie uma autorização no valor de 0 para que o titular valide o número de cartão fornecido. O titular tem de fornecer informações válidas para concluir a verificação.
A verificação pode ser concluída através da página alojada pela YabandPay. Os comerciantes podem receber pedidos com segurança, mantendo os dados sensíveis abrangidos pelo PCI DSS nos sistemas da YabandPay.
Dica
Obtenha o resultado da verificação através de Order Query.
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| user | String | Conta do operador de caixa UID | Obrigatório |
| sign | String | Signature | Obrigatório |
| method | String | v3.CardCheck | Obrigatório |
| time | Long | Timestamp | Obrigatório |
- Parameters
| Parâmetro | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| pay_method | String | online | Obrigatório |
| sub_pay_method | String | CardCheck | Obrigatório |
| operation | String | 3 | Obrigatório |
| order_id | String | ID do pedido do comerciante | Obrigatório |
| description | String | Descrição do pedido | Obrigatório |
| form_type | String | Tipo de url devolvido; por predefinição, 01. 01.completed, 02.iframe | Opcional |
| demo | String | Campo personalizado | Opcional |
| timeout | String | Tempo de expiração em minutos (0-1440) | Obrigatório |
| redirect_url | String | URL de redirecionamento após o pagamento | Opcional |
| notify_url | String | URL de notificação assíncrona após o pagamento | Obrigatório |
| request_id | String | ID de pedido único; recomenda-se uma combinação de letras e números com pelo menos 24 caracteres | Obrigatório |
Signature example:
Parâmetros ordenados e concatenados numa cadeia de consulta no formato de URL
"description=cardcheck test&form_type=01&method=v3.CardCheck¬ify_url=https://www.yabandpay.com/notify&operation=3&order_id=203040950640690239603690&pay_method=online&redirect_url=https://www.yabandpay.com/redirect_url&request_id=tscqf7ki76o7aem4z1yl1xs72f89fptl&sub_pay_method=CardCheck&time=1720680417&timeout=0&user=YOUR_CASHIER_UID"
Assine a stringA utilizando secret_key
A assinatura resultante é:
"YOUR_SIGNATURE"
Request example:
{
"user": "YOUR_CASHIER_UID",
"sign": "YOUR_SIGNATURE",
"method": "v3.CardCheck",
"time": 1720680417,
"data": {
"description": "cardcheck test",
"form_type": "01",
"timeout": "0",
"pay_method": "online",
"sub_pay_method": "CardCheck",
"operation": "3",
"order_id": "YOUR_ORDER_ID",
"redirect_url": "https://www.yabandpay.com/redirect_url",
"notify_url": "https://www.yabandpay.com/notify",
"request_id": "tscqf7ki76o7aem4z1yl1xs72f89fptl"
}
}
Response example:
{
"status": true,
"code": "200",
"data": {
"order_id": "YOUR_ORDER_ID",
"trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
"amount": "0.00",
"currency": "EUR",
"url": "https://pay.yabandpay.com/payments/callback/order/MTYwODk5ZjMtZjZkOS1hOGQ4LWFiNWItODJlYWNkYWI5YzVi",
"state": "processing"
},
"message": "",
"response_id": "202407111544200649155078"
}
Additional information:
Response result:
-
Um pedido bem-sucedido devolve "status": true.
-
Um pedido mal-sucedido devolve "status": false.
Redirecione para url. Depois de o utilizador introduzir os dados do cartão nesta url e concluir o pagamento, será redirecionado de forma síncrona para redirect_url. Recomendamos vivamente a utilização de Order Query e de Asynchronous Notifications para sincronizar e atualizar o estado do pagamento e manter as informações corretas em tempo real. a) Se o estado do pedido state for paid, o pagamento foi bem-sucedido;
Response codes:
| Status | Code | Message |
|---|---|---|
| true | 200 | |
| false | -1000 | Internal error |
| false | -403 | The signature Error |
| false | -2001 | The user not exist |
| false | -3001 | Required field is missing |
| false | -4118 | Incorrect request ID |
