Documentación/Referencia de API

API REFERENCE

Cancelar una divesión de pago

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

Cancelar una divesión de pago

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

Request parameters4

Required fields first

取消分账

commandRequiredstringdata.commandCancelSplitPayment
nonce_stringRequiredstringdata.nonce_string随机字符串,不长于32位
reference_idRequiredstringdata.reference_id商户方的分账id,不长于32位
split_idRequiredstringdata.split_id创建分账后的分账单号

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

Parámetros

ParameterTypeDescripciónObligatorio
data.commandstringCancelSplitPayment✓
data.nonce_stringstring随机字符串,不长于32位✓
data.reference_idstring商户方的分账id,不长于32位✓
data.split_idstring创建分账后的分账单号✓

Esta API cancela una orden de divesión de pago de YabandPay cuyo estado es Processing.

ParámetroTipoDescripciónObligatorio
userStringUID de la cuenta de superadminestradorObligatorio
signStringSignatureObligatorio
methodStringv3.SplitPaymentObligatorio
timeLongTimestampObligatorio
  • Parámetros
ParámetroTipoDescripciónObligatorio
commandStringCancelSplitPaymentObligatorio
nonce_stringStringCadena aleatoria de un máximo de 32 caracteresObligatorio
reference_idStringID de divesión de pago del comercio, de un máximo de 32 caracteresObligatorio
split_idStringNúmero de orden de divesión de pago generado al crear la divesiónObligatorio

Ejemplo de firma:

Parámetros ordenados y concatenados en una cadena de consulta con formato de URL

"command=cancelSplitPayment&method=v3.SplitPayment&nonce_string=0y9nydkzlmivuhs5xz&reference_id=123456&split_id=20231229110618372777&time=1703832252&user=9212776037"

Firme la cadena A con secret_key

La firma resultante es:

"YOUR_SIGNATURE"

Ejemplo de solicitud:

{
    "user": "9212776037",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.SplitPayment",
    "time": 1703832252,
    "data": {
        "command": "cancelSplitPayment",
        "nonce_string": "0y9nydkzlmivuhs5xz",
        "split_id": "20231229110618372777",
        "reference_id": "123456"
    }
}

Ejemplo de respuesta:

{
    "status": true,
    "code": "200",
    "data": {
        "split_id": "20231229110618372777",
        "reference_id": "123456",
        "state": "Cancelled"},
    "message": ""
}
  • Parámetros de respuesta
ParámetroTipoDescripción
split_idStringNúmero de orden de divesión de pago generado al crear la divesión
stateStringStatus: Cancelled or Failed
reference_idStringID de divesión de pago del comercio, de un máximo de 32 caracteres
referenceStringDescripción, de un máximo de 128 caracteres