Documentatie/API-referentie

API REFERENCE

Terugbetaling opvragen

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

Terugbetaling opvragen

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.

API-URL:https://mapi.yabandpay.com/Payments

Methode:POST

POST gegevenstype:Json

ParameterTypeBeschrijvingVerplicht
userStringKassieraccount UIDVerplicht
signStringSignatureVerplicht
methodStringv3.QueryRefundOrderVerplicht
timeLongTimestampVerplicht
  • Parameters
ParameterTypeBeschrijvingVerplicht
refund_idStringYabandPay-terugbetalingsordernummerOptioneel (een van beide velden is verplicht)
m_refund_idStringTerugbetalingsordernummer van de merchantOptioneel (een van beide velden is verplicht)

Voorbeeld van een handtekening:

Parameters op volgorde samengevoegd tot een querystring in URL-stijl

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

Onderteken stringA met secret_key

De gegenereerde handtekening is:

"YOUR_SIGNATURE"

Voorbeeld van een aanvraag:

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

Voorbeeld van een antwoord:

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

Aanvullende informatie:

Resultaat van het antwoord:
  1. Bij een geslaagde aanvraag wordt "status": true geretourneerd.

  2. Bij een mislukte aanvraag wordt "status": false geretourneerd.

Terugbetalingsstatus:
CodeStatusBericht
20to-be-approvalWacht op goedkeuring door de beheerder.
21refund pendingHet huidige saldo is onvoldoende. De terugbetaling wordt automatisch ingediend zodra er voldoende saldo beschikbaar is.
22refund processingHet terugbetalingsverzoek is ingediend en wordt door het systeem verwerkt.
23refundedDe terugbetaling is geslaagd.
24refund failedDe terugbetaling is mislukt. Probeer het opnieuw.
25refund errorDe terugbetaling is mislukt. Neem contact op met onze online klantenservice.
26refund cancelledDe terugbetalingsorder is geannuleerd.