Documentação/Referência da API

API REFERENCE

Pagamentos por token

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

Pagamentos por token

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

Request parameters12

Required fields first

Token支付

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodToken
operationRequiredstringdata.operation11.Token for sales 12.Token for authorisation;
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
payment_token_objectRequiredstringdata.payment_token_object支付Token
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 1
demoOptionalstringdata.demo自定义字段

请求参数

3ds_initiateRequiredstringdata.3ds_initiate01. 开启3ds验证; 02.不开启3DS(需申请开通);03. SCA豁免(需申请开通);

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_methodstringToken✓
data.operationstring11.Token for sales 12.Token for authorisation;✓
data.order_idinteger商户的订单ID✓
data.sca_exemptionstringLowValue✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.payment_token_objectstring支付Token✓
data.descriptionstring订单描述✓
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.notify_urlstring支付完成后异步通知地址✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓
data.3ds_initiatestring01. 开启3ds验证; 02.不开启3DS(需申请开通);03. SCA豁免(需申请开通);✓

Aplica-se a: iniciar pagamentos com Token — cartões de crédito

Depois que o pagador conclui uma transação padrão com cartão de crédito na página hospedada da YabandPay e dá seu consentimento, a YabandPay converte os dados confidenciais do titular do cartão em uma cadeia numérica aleatória (um Token) para remover informações de identificação. O Token pode ser usado nos seguintes pagamentos:

  1. Os usuários podem pagar com um clique na página de checkout, sem inserir os dados do cartão de crédito.
  2. Os estabelecimentos podem usar este Token para pagamentos recorrentes, cobranças de assinaturas e finalidades semelhantes.

[!TIP|style:flat] Fluxo de trabalho

  1. Ative os pagamentos com Token. Entre em contato com seu gerente de conta para habilitar esse recurso.
  1. Obtenha o consentimento do usuário. Ao habilitar pagamentos expressos (pagamentos com Token) para consumidores, informe-os claramente e obtenha seu consentimento para evitar possíveis disputas.
  1. Obtenha um Token. Primeiro, inicie uma transação padrão com cartão de crédito. A YabandPay retorna um url de pagamento. Depois que o usuário conclui o pagamento nesse url e dá seu consentimento, a YabandPay retorna o Token em uma notificação assíncrona usando o parâmetro payment_token_object.
  1. Inicie um pagamento com Token. Inclua o Token na variável payment_token_object. Se a validação do Token for bem-sucedida, a YabandPay processará o pagamento. Se falhar, a YabandPay retornará um erro. Nesse caso, recomendamos iniciar outra transação padrão com cartão de crédito para obter um Token e iniciar o pagamento novamente.
ParâmetroTipoDescriçãoObrigatório
userStringConta de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.CreateCardPaymentsObrigatório
timeLongTimestampObrigatório
  • Parâmetros
ParâmetroTipoDescriçãoObrigatório
pay_methodStringonlineObrigatório
sub_pay_methodStringTokenObrigatório
operationString11.Token for sales 12.Token for authorisation;Obrigatório
order_idStringID do pedido do estabelecimentoObrigatório
3ds_initiateString01. Enable 3DS verification; 02. Disable 3DS (requires activation approval); 03. SCA exemption (requires activation approval).Obrigatório
sca_exemptionStringLowValue3ds_initiate=03 Required
amountStringValor como cadeia numérica. Por exemplo, informe 24.99 for € 24.99.Obrigatório
currencyStringCódigo da moeda ISO 4217 currency code, for example EUR or CHFObrigatório
payment_token_objectStringToken de pagamentoObrigatório
descriptionStringDescrição do pedidoObrigatório
demoStringCampo personalizadoOpcional
timeoutStringTempo de expiração em minutos (0-1440)Obrigatório
notify_urlStringURL de notificação assíncrona após o pagamentoObrigatório
request_idStringID de solicitação exclusivo; recomenda-se uma combinação de letras e números com pelo menos 24 characters is recommendedObrigatório

Exemplo de assinatura:

Parâmetros ordenados concatenados em uma cadeia de consulta no formato de URL

"3ds_initiate=01&amount=1&currency=EUR&description=test&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=11&order_id=1725875543&pay_method=online&payment_token_object=VnXaRabcsedfsSlPFZXavcsdfasdEFDd&request_id=hjf5lv32i40lh7oh86j6az98tnscwv37&sub_pay_method=Token&time=1725875543&timeout=0&user=YOUR_CASHIER_UID"

Assine a stringA usando secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Exemplo de solicitação:

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.CreateCardPayments",
    "time": 1725875543,
    "data": {
        "3ds_initiate": "01",
        "description": "test",
        "timeout": "0",
        "pay_method": "online",
        "sub_pay_method": "Token",
        "operation": "11",
        "order_id": 1725875543,
        "amount": "1",
        "currency": "EUR",
        "payment_token_object": "VnXaRabcsedfsSlPFZXavcsdfasdEFDd",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "hjf5lv32i40lh7oh86j6az98tnscwv37"
    }
}

Exemplo de resposta:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "109bb0e9-e1fb-49cb-c537-ec944f33c388",
        "amount": "1.00",
        "currency": "EUR",
        "state": "paid"
    },
    "message": "",
    "response_id": "202409091752241912726578"
}

Informações adicionais:

MIT & CIT :

MIT = transações subsequentes iniciadas pelo estabelecimento. Pagamentos com Token iniciados pelo estabelecimento.

CIT = transações subsequentes iniciadas pelo titular do cartão. Pagamentos com Token iniciados pelo cliente. Ao ativar os pagamentos, especifique se precisa de MIT ou CIT para que o modo apropriado seja configurado.

Resultado da resposta:
  1. Uma solicitação bem-sucedida retorna "status": true.

  2. Se a chamada falhar, "status": false é retornado. Se você receber Invalid Token, recomendamos chamar novamente HPP Token para obter um novo Token.

A API retorna o status do pagamento de forma síncrona. Recomendamos fortemente usar Order Query e Asynchronous Notifications para sincronizar e atualizar o status do pagamento e manter as informações corretas em tempo real. a) Se o status do pedido state for paid, o pagamento foi bem-sucedido; b) se o status do pedido state for authorized, a autorização foi bem-sucedida. Para capturar os fundos após a autorização bem-sucedida, chame a API de captura de autorização.

3DS low-value exemption:

Transações dentro dos limites a seguir podem se qualificar como transações de baixo valor. Se o valor do pedido for menor ou igual ao limite aplicável abaixo, o código 02 (isenção para baixo valor) poderá ser usado mediante aprovação.

#CurrencyAmount
1EUR30
2DKK225
3GBP27
4SEK310
5ISK5000
6NOK325
7CHF32
8PLN135
9USD36
Códigos de resposta:
StatusCodeMessage
true200
false-1000Internal error
false-403The signature Error
false-2001The user not exist
false-3001Required field is missing
false-4118Incorrect request ID
false-4119Invalid Token
false-4120No operational permissions