API REFERENCE

Augmenter l’autorisation

YabandPay documentation·Mis à jour le 26 oct. 2026

Paramètres

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

Paramètre	Type	Description	Obligatoire
user	String	Cashier account UID	Obligatoire
sign	String	Signature	Obligatoire
method	String	v3.PreauthIncrement	Obligatoire
time	Long	Timestamp	Obligatoire

Parameters

Paramètre	Type	Description	Obligatoire
trade_id	String	trade_id of the authorization to increase	Obligatoire
amount	String	Numeric amount. For example, € 24.99 must be written as 24.99	Obligatoire
currency	String	ISO 4217 currency code, such as EUR or CHF	Obligatoire
description	String	Order description	Obligatoire
notify_url	String	Asynchronous notification URL after payment completion	Obligatoire
request_id	String	Unique request id; at least 24 alphanumeric characters are recommended	Obligatoire

Signature example:

Sorted parameters concatenated into a URL-style query string

"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"

Sign stringA using secret_key

Le champ resulting signature is:

"YOUR_SIGNATURE"

Exemple de requête:

{
  "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"
  }
}

Exemple de réponse:

{
  "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"
}

Informations complémentaires:

Résultat de la réponse:

Une requête réussie renvoie "status": true.
Une requête échouée renvoie "status": false.

Cette API augmente le montant de l’autorisation. Le résultat est renvoyé de manière synchrone.

Response codes:

Status	Code	Message
true	200
false	-1000	Internal error
false	-403	The signature Error
false	-2001	The user not exist
false	-3001	Required field is missing
false	-4118	Incorrect request ID
false	-4024	The original trade ID is incorrect