Documentação/Referência da API

API REFERENCE

CardCheck

POSThttps://mapi.yabandpay.com/Payments
Live API
API PLAYGROUND · Live API

CardCheck

POSThttps://mapi.yabandpay.com/Payments
Automatically signed with your credentials

Request parameters10

Required fields first

CardCheck

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCardCheck
operationRequiredstringdata.operation3
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 3
form_typeOptionalstringdata.form_type返回的url类型,默认01。 01.completed, 02.iframe
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

Credentials stay on this page. Your secret key is never stored or sent to the documentation server.

Parâmetros

ParameterTypeDescriçãoObrigatório
data.pay_methodstringonline✓
data.sub_pay_methodstringCardCheck✓
data.operationstring3✓
data.order_idstring商户的订单ID✓
data.descriptionstring订单描述✓
data.form_typestring返回的url类型,默认01。 01.completed, 02.iframe—
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址—
data.notify_urlstring支付完成后异步通知地址✓
data.request_idstring请求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âmetroTipoDescriçãoObrigatório
userStringConta do operador de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.CardCheckObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
pay_methodStringonlineObrigatório
sub_pay_methodStringCardCheckObrigatório
operationString3Obrigatório
order_idStringID do pedido do comercianteObrigatório
descriptionStringDescrição do pedidoObrigatório
form_typeStringTipo de url devolvido; por predefinição, 01. 01.completed, 02.iframeOpcional
demoStringCampo personalizadoOpcional
timeoutStringTempo de expiração em minutos (0-1440)Obrigatório
redirect_urlStringURL de redirecionamento após o pagamentoOpcional
notify_urlStringURL de notificação assíncrona após o pagamentoObrigatório
request_idStringID de pedido único; recomenda-se uma combinação de letras e números com pelo menos 24 caracteresObrigató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&notify_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:
  1. Um pedido bem-sucedido devolve "status": true.

  2. 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:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID