Documentation/Référence API

API REFERENCE

Consulter un remboursement

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

Consulter un remboursement

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

Request parameters2

Required fields first

退款查询

Optional parameters 2
refund_idAt least onestringdata.refund_idYabandPay退款单号选填 (必须包含一个)
m_refund_idAt least onestringdata.m_refund_id商户退款单号选填(必须包含一个)

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

Paramètres

ParameterTypeDescriptionObligatoire
data.refund_idstringYabandPay退款单号—
data.m_refund_idstring商户退款单号—
ParamètreTypeDescriptionObligatoire
userStringCompte caissier UIDObligatoire
signStringSignatureObligatoire
methodStringv3.QueryRefundOrderObligatoire
timeLongTimestampObligatoire
  • Parameters | Paramètre | Type | Description | Obligatoire | |:------------|:--- |:--------------|:-------------------| | refund_id | String | Numéro de remboursement YabandPay | Facultatif (l’un des deux paramètres doit être fourni) | | m_refund_id | String | Numéro de remboursement du marchand | Facultatif (l’un des deux paramètres doit être fourni) |

Exemple de signature :

Paramètres triés et concaténés dans une chaîne de requête au format URL

"method=v3.QueryRefundOrder&time=1728566835&refund_id=3841510a-4d18-4a61-808d-431a45006de2&user=YOUR_CASHIER_UID"

Signer stringA avec secret_key

La signature obtenue est :

"YOUR_SIGNATURE"

Exemple de requête :

{
    "user": "YOUR_CASHIER_UID",
    "sign": "YOUR_SIGNATURE",
    "method": "v3.QueryRefundOrder",
    "time": 1728566835,
    "data": {
        "refund_id": "3841510a-4d18-4a61-808d-431a45006de2"
    }
}

Exemple de réponse :

{
    "status": true,
    "code": "200",
    "data": {

            "transaction_id": "20240903153820059756",
            "refund_id": "20240903154342497308",
            "m_refund_id": null,
            "refund_time": "1725349422",
            "state": "refunded",
            "refund_amount": "0.01",
            "refund_currency": "EUR",
            "refund_description": "gary",
            "notify_url": "null",
            "demo": "",
            "settlement_refund_amount": "0.01",
            "settlement_refund_currency": "EUR",
            "merchant_cost": "0.1",
            "yb_transaction_id": "c07859aa-3d12-69d4-ef2f-a9556d9c4d33"
        },
    "message": ""
}

Informations complémentaires :

Résultat de la réponse :
  1. Une requête réussie renvoie "status": true.

  2. Une requête échouée renvoie "status": false.

Statut du remboursement :
CodeStateMessage
20to-be-approvalEn attente de l’approbation d’un administrateur.
21refund pendingLe solde actuel est insuffisant. Le remboursement sera soumis automatiquement lorsque les fonds seront suffisants.
22refund processingLa demande de remboursement a été soumise et est en cours de traitement par le système.
23refundedLe remboursement a été effectué avec succès.
true24
false-25Internal error
false-26The signature Error