Documentação/Referência da API

API REFERENCE

Aumentar autorização

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

Aumentar autorização

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

Request parameters6

Required fields first

增加预授权

trade_idRequiredstringdata.trade_id对应增加预授权的trade_id
amountRequiredstringdata.amount金额数字。例如 € 24.99 应该写成24.99
currencyRequiredstringdata.currency货币代码,ISO 4217,例如EUR,CHF
descriptionRequiredstringdata.description订单描述
notify_urlRequiredstringdata.notify_url支付完成后异步通知地址
request_idRequiredstringdata.request_id请求id需保持唯一,建议24以上位数字+字母

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

Parâmetros

ParameterTypeDescriçãoObrigatório
data.trade_idstring对应增加预授权的trade_id✓
data.amountstring金额数字。例如 € 24.99 应该写成24.99✓
data.currencystring货币代码,ISO 4217,例如EUR,CHF✓
data.descriptionstring订单描述✓
data.notify_urlstring支付完成后异步通知地址✓
data.request_idstring请求id需保持唯一,建议24以上位数字+字母✓
ParâmetroTipoDescriçãoObrigatório
userStringConta de caixa UIDObrigatório
signStringSignatureObrigatório
methodStringv3.PreauthIncrementObrigatório
timeLongTimestampObrigatório
  • Parâmetros
ParâmetroTipoDescriçãoObrigatório
trade_idStringtrade_id of the authorization to increaseObrigatório
amountStringValor numérico. Por exemplo, € 24.99 must be written as 24.99Obrigatório
currencyStringCódigo da moeda ISO 4217 currency code, such as EUR or CHFObrigatório
descriptionStringDescrição do pedidoObrigatório
notify_urlStringURL de notificação assíncrona após o pagamento completionObrigatório
request_idStringID de solicitação exclusivo; recomenda-se pelo menos 24 alphanumeric characters are recommendedObrigatório

Exemplo de assinatura:

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

"amount=1&currency=EUR&description=test&method=v3.PreauthIncrement&notify_url=https://www.yabandpay.com/notify&request_id=ca51f2fas3i0f8uiw7efj6oe4i2w1ghj&time=1720684254&trade_id=160899f3-f6d9-a8d8-ab5b-82eacdab9c5b&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.PreauthIncrement",
  "time": 1720684254,
  "data": {
    "description": "test",
    "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
    "amount": "1",
    "currency": "EUR",
    "notify_url": "https://www.yabandpay.com/notify",
    "request_id": "ca51f2fas3i0f8uiw7efj6oe4i2w1ghj"
  }
}

Exemplo de resposta:

{
  "status": true,
  "code": "200",
  "data": {
    "order_id": "YOUR_ORDER_ID",
    "trade_id": "160899f3-f6d9-a8d8-ab5b-82eacdab9c5b",
    "amount": "1",
    "currency": "EUR",
    "state": "authorized"
  },
  "message": "",
  "response_id": "202407111550570060848432"
}

Informações adicionais:

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

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

Esta API aumenta o valor da autorização. O resultado é retornado de forma síncrona.

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-4024The original trade ID is incorrect