Documentação/Referência da API

API REFERENCE

Obter Token

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

Obter Token

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

Request parameters15

Required fields first

获取Token(HPP)

pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodCards HPP
operationRequiredstringdata.operation10.Create Token only; 11.Token for sales; 12.Token for authorisation
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99。如果operation为10,请设置amount=0
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
emailRequiredstringdata.email持卡人email
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
Optional parameters 4
cardinfoOptionalstringdata.cardinfo卡信息
form_typeOptionalstringdata.form_type返回的url类型,默认01。 01.completed, 02.iframe
demoOptionalstringdata.demo自定义字段
redirect_urlOptionalstringdata.redirect_url支付完成后跳转地址

请求参数

3ds_initiateRequiredstringdata.3ds_initiate3ds设置。 01. 必须开启3ds验证;

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_methodstringCards HPP✓
data.operationstring10.Create Token only; 11.Token for sales; 12.Token for authorisation✓
data.order_idinteger商户的订单ID✓
data.cardinfostring卡信息—
data.amountstring金额数字。例如 € 24.99 应该写成24.99。如果operation为10,请设置amount=0✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.descriptionstring订单描述✓
data.form_typestring返回的url类型,默认01。 01.completed, 02.iframe—
data.demostring自定义字段—
data.emailstring持卡人email✓
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址—
data.notify_urlstring支付完成后异步通知地址✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓
data.3ds_initiatestring3ds设置。 01. 必须开启3ds验证;✓

Aplica-se à obtenção de um Token pela página de pagamento hospedada da YabandPay

A Hosted Payment Page (HPP) da YabandPay é uma página de pagamento pronta para uso e totalmente mantida pela YabandPay. Os estabelecimentos podem aceitar pagamentos com segurança, mantendo os dados confidenciais sujeitos ao PCI no sistema da YabandPay. O formulário pode ser incorporado ao fluxo de checkout do estabelecimento como um iframe ou uma página de redirecionamento.

Depois que o pagador conclui uma transação padrão com cartão de crédito na página de pagamento hospedada da YabandPay e dá seu consentimento, A YabandPay converte os dados confidenciais do titular do cartão em uma cadeia 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_methodStringCards HPPObrigatório
operationString10.Create Token only; 11.Token for sales; 12.Token for authorisationObrigatório
order_idStringID do pedido do estabelecimentoObrigatório
3ds_initiateString3ds settings. 01. 3ds verification must be enabled;Obrigatório
cardinfoStringInformações do cartãoTrate o valor de cardinfo como uma cadeia (não é necessário incluir os campos dentro de cardinfo na ordenação)
cardinfo.card_holderstringNome do titular do cartãoObrigatório
cardinfo.card_numberstringNúmero do cartãoObrigatório
cardinfo.expiration_monthstringMês de validade do cartão, MMObrigatório
cardinfo.expiration_yearstringAno de validade do cartão, YYYYObrigatório
cardinfo.cvcstringCVC (armazenar o CVC em qualquer formato viola os requisitos do PCI DSS)Obrigatório
amountStringValor numérico. Por exemplo, € 24.99 must be written as 24.99. If operation is 10, set amount=0Obrigatório
currencyStringCódigo da moeda ISO 4217 currency code, for example EUR or CHFObrigatório
descriptionStringDescrição do pedidoObrigatório
form_typeStringType of the returned url. Default: 01. 01.completed, 02.iframeOpcional
demoStringCampo personalizadoOpcional
emailstringE-mail do titular do cartãoObrigatório
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 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=0.1&currency=EUR&description=test&email=JohnSmith@gmail.com&form_type=01&method=v3.CreateCardPayments&notify_url=https://www.yabandpay.com/notify&operation=11&order_id=1725875388&pay_method=online&request_id=dxktqiedfpkswnripi631ppg6fl2uoym&sub_pay_method=Cards HPP&time=1725875388&timeout=30&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": 1725875388,
    "data": {
        "3ds_initiate": "01",
        "description": "test",
        "timeout": "30",
        "pay_method": "online",
        "sub_pay_method": "Cards HPP",
        "operation": "11",
        "form_type": "01",
        "order_id": 1725875388,
        "amount": "0.1",
        "currency": "EUR",
        "email": "JohnSmith@gmail.com",
        "notify_url": "https://www.yabandpay.com/notify",
        "request_id": "dxktqiedfpkswnripi631ppg6fl2uoym"
    }
}

Exemplo de resposta:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "2b2aa1af-6e97-4c01-8c52-86200bf66c82",
        "amount": "0.1",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/pay_method/Y3JlZGl0Y2FyZA==/MmIyYWExYWYtNmU5Ny00YzAxLThjNTItODYyMDBiZjY2Yzgy",
        "state": "processing"
    },
    "message": "",
    "response_id": "202409091749500451314672"
}

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.

Payment result:
  1. Uma solicitação bem-sucedida retorna "status": true.

  2. Uma solicitação malsucedida retorna "status": false.

Redirecione o cliente para url, que foi retornado. Depois de inserir os dados do cartão e concluir o pagamento nesse url, o cliente será redirecionado para redirect_url. Recomendamos fortemente usar Query Order e Asynchronous Notifications para manter os status de pagamento corretos e atualizados.

Returned Token:
  1. Depois que o cliente concede a autorização e o pagamento é aprovado, a YabandPay retorna payment_token_object por meio de uma notificação assíncrona.

  2. Se o cliente não conceder a autorização ou não concluir o pagamento, a notificação assíncrona não retornará payment_token_object.

3DS low-value exemption:

As 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 de transação 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-4120No operational permissions