Dokumentation/API-Referenz

API REFERENCE

Rückerstattung abfragen

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

Rückerstattung abfragen

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.

ParameterTypBeschreibungErforderlich
userStringKassiererkonto UIDErforderlich
signStringSignatureErforderlich
methodStringv3.QueryRefundOrderErforderlich
timeLongTimestampErforderlich
  • Parameter
ParameterTypBeschreibungErforderlich
refund_idStringYabandPay-RückerstattungsauftragsnummerOptional (mindestens eine Angabe ist erforderlich)
m_refund_idStringHändlerseitige RückerstattungsauftragsnummerOptional (mindestens eine Angabe ist erforderlich)

Signaturbeispiel:

Die sortierten Parameter werden zu einer URL-ähnlichen Abfragezeichenfolge verkettet.

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

Signieren Sie stringA mit secret_key.

Die resultierende Signatur lautet:

"YOUR_SIGNATURE"

Anfragebeispiel:

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

Antwortbeispiel:

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

Weitere Informationen:

Antwortergebnis:
  1. Bei erfolgreichem Aufruf wird "status": true zurückgegeben.

  2. Bei fehlgeschlagenem Aufruf wird "status": false zurückgegeben.

Rückerstattungsstatus:
CodeStatusMeldung
20to-be-approvalWartet auf Genehmigung durch den Administrator.
21refund pendingDas aktuelle Guthaben reicht nicht aus. Die Rückerstattung wird automatisch eingereicht, sobald genügend Guthaben verfügbar ist.
22refund processingDer Rückerstattungsantrag wurde übermittelt und wird vom System bearbeitet.
23refundedDie Rückerstattung wurde erfolgreich abgeschlossen.
24refund failedDie Rückerstattung ist fehlgeschlagen. Bitte versuchen Sie es erneut.
25refund errorDie Rückerstattung ist fehlgeschlagen. Bitte wenden Sie sich an unseren Online-Kundendienst.
26refund cancelledDer Rückerstattungsauftrag wurde storniert.