Documentação/Referência da API

API REFERENCE

Transferência bancária

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

Transferência bancária

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

Request parameters11

Required fields first

介绍

request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母
pay_methodRequiredstringdata.pay_methodonline
sub_pay_methodRequiredstringdata.sub_pay_methodBank Transfer
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99,欧元金额>=1
currencyRequiredstringdata.currencyEUR
descriptionRequiredstringdata.description订单描述
timeoutRequiredstringdata.timeout过期时间单位分钟(0-1440)
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
Optional parameters 3
emailOptionalstringdata.email用户邮箱
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.request_idstring请求id需保持唯一,建议24以上位数字+字母✓
data.pay_methodstringonline✓
data.sub_pay_methodstringBank Transfer✓
data.order_idstring商户的订单ID✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99,欧元金额>=1✓
data.currencystringEUR✓
data.descriptionstring订单描述✓
data.emailstring用户邮箱—
data.demostring自定义字段—
data.timeoutstring过期时间单位分钟(0-1440)✓
data.redirect_urlstring支付完成后跳转地址—
data.notify_urlstring支付完成后异步通知地址✓

Aplicável a: transferências bancárias do utilizador

Paybybank é um método seguro de pagamento por transferência bancária disponibilizado pela YabandPay. Os clientes pagam transferindo fundos diretamente das suas contas bancárias para a conta indicada pela YabandPay.

Esta solução é ideal para comerciantes que procuram custos mais baixos e transações fiáveis sem depender de redes de cartões. Assim que recebe a transferência, a YabandPay verifica automaticamente o pagamento e atualiza o estado da transação, proporcionando uma experiência de pagamento simples para comerciantes e clientes.

Dica

O Paybybank só aceita transferências através da rede SEPA (Área Única de Pagamentos em Euros). Não são aceites transferências SWIFT.

ParâmetroTipoDescriçãoObrigatório
userStringConta do operador de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.BankTransferObrigatório
timeLongTimestampObrigatório
  • Parameters
ParâmetroTipoDescriçãoObrigatório
request_idStringID de pedido único; recomenda-se uma combinação de letras e números com pelo menos 24 caracteresObrigatório
pay_methodStringonlineObrigatório
sub_pay_methodStringBank TransferObrigatório
order_idStringID do pedido do comercianteObrigatório
amountStringMontante numérico. Por exemplo, € 24.99 deve ser indicado como 24.99; montante em euros >=1Obrigatório
currencyStringEURObrigatório
descriptionStringDescrição do pedidoObrigatório
emailStringEndereço de e-mail do utilizadorOpcional
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

Signature example:

Parâmetros ordenados e concatenados numa cadeia de consulta no formato de URL

"amount=0.1&currency=EUR&demo=test&description=Test&email=info@yabandmedia.com&method=v3.BankTransfer&notify_url=https://www.yabandpay.com/notify&order_id=12455555788&pay_method=online&redirect_url=https://www.yabandpay.com&request_id=001123456789&sub_pay_method=Bank Transfer&time=1653145918&timeout=0&user=YOUR_CASHIER_UID"

Assine a stringA utilizando secret_key

A assinatura resultante é:

"YOUR_SIGNATURE"

Request example:

{
    "user": "YOUR_CASHIER_UID",
    "method": "v3.BankTransfer",
    "time": "1653145918",
    "sign": "YOUR_SIGNATURE",
    "data": {
        "request_id": "001123456789",
        "order_id" : "YOUR_ORDER_ID",
        "pay_method": "online",
        "sub_pay_method": "Bank Transfer",
        "email": "info@yabandmedia.com",
        "description": "Test", 
        "timeout" : "0",
        "amount": "0.1",
        "currency": "EUR",
        "redirect_url": "https://www.yabandpay.com",
        "notify_url" : "https://www.yabandpay.com/notify",
        "demo": "test"
    }
}

Response example:

{
    "status": true,
    "code": "200",
    "data": {
        "order_id": "YOUR_ORDER_ID",
        "trade_id": "d3a81009-2b3c-9f2c-8e33-45dc932ee757",
        "amount": "0.10",
        "currency": "EUR",
        "url": "https://pay.yabandpay.com/prod/bank_transfer/ZDNhODEwMDktMmIzYy05ZjJjLThlMzMtNDVkYzkzMmVlNzU3",
        "state": "processing"
    },
    "message": "",
    "response_id": "202505131817352897785689"
}

Additional information:

Response result:
  1. Um pedido bem-sucedido devolve "status": true.

  2. Um pedido mal-sucedido devolve "status": false.

Recomendamos utilizar Asynchronous Notifications para atualizar o estado do pagamento e manter as informações corretas em tempo real.

Response codes:
StatusCodeMessage
true200Success
false-1000Internal error
false-3001Required field is missing
false-403The signature Error
false-4011Not support the payment method