curl --request POST \
--url https://sandbox.birrpay.io/v2/refunds \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 654,
"merchant_reference_id": "ref_123",
"payment_id": "{{payment_id}}",
"refund_type": "instant"
}
'{
"id": "<string>",
"payment_id": "<string>",
"amount": 6540,
"currency": "AED",
"status": "succeeded",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"connector": "authipay",
"profile_id": "<string>",
"merchant_connector_id": "<string>",
"merchant_reference_id": "ref_mbabizu24mvu3mela5njyhpit4",
"reason": "<string>",
"metadata": {},
"error_details": {
"code": "<string>",
"message": "<string>"
},
"connector_refund_reference_id": "<string>",
"raw_connector_response": "<string>"
}{
"error_type": "invalid_request",
"message": "Missing required param: {param}",
"code": "IR_04"
}Refunds - Create
Creates a refund against an already processed payment. In case of some processors, you can even opt to refund only a partial amount multiple times until the original charge amount has been refunded
curl --request POST \
--url https://sandbox.birrpay.io/v2/refunds \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 654,
"merchant_reference_id": "ref_123",
"payment_id": "{{payment_id}}",
"refund_type": "instant"
}
'{
"id": "<string>",
"payment_id": "<string>",
"amount": 6540,
"currency": "AED",
"status": "succeeded",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"connector": "authipay",
"profile_id": "<string>",
"merchant_connector_id": "<string>",
"merchant_reference_id": "ref_mbabizu24mvu3mela5njyhpit4",
"reason": "<string>",
"metadata": {},
"error_details": {
"code": "<string>",
"message": "<string>"
},
"connector_refund_reference_id": "<string>",
"raw_connector_response": "<string>"
}{
"error_type": "invalid_request",
"message": "Missing required param: {param}",
"code": "IR_04"
}Authorizations
Format: api-key=<api_key>
Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
Body
The payment id against which refund is initiated
30"pay_mbabizu24mvu3mela5njyhpit4"
Unique Identifier for the Refund given by the Merchant.
1 - 64"ref_mbabizu24mvu3mela5njyhpit4"
The identifier for the Merchant Account
255"y3oqhf46pyzuxjbcn2giaqnb44"
Total amount for which the refund is to be initiated. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc., If not provided, this will default to the amount_captured of the payment
x >= 1006540
Reason for the refund. Often useful for displaying to users and your customer support executive.
255"Customer returned the product"
To indicate whether the refund needs to be instant or scheduled
scheduled, instant Metadata is useful for storing additional, unstructured information on an object.
Merchant connector details
Show child attributes
Show child attributes
If true, returns stringified connector raw response body
Response
Refund created
Global Refund Id for the refund
The payment id against which refund is initiated
The refund amount
x >= 1006540
The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL The status for refunds
succeeded, failed, pending, review The timestamp at which refund is created
The timestamp at which refund is updated
authipay, adyenplatform, stripe_billing_test, phonypay, fauxpay, pretendpay, stripe_test, adyen_test, checkout_test, paypal_test, aci, adyen, affirm, airwallex, amazonpay, archipel, authorizedotnet, bambora, bamboraapac, bankofamerica, barclaycard, billwerk, bitpay, bluesnap, blackhawknetwork, calida, boku, braintree, breadpay, cardinal, cashtocode, celero, chargebee, checkbook, checkout, coinbase, coingate, custombilling, cryptopay, ctp_mastercard, ctp_visa, cybersource, datatrans, deutschebank, digitalvirgo, dlocal, dwolla, ebanx, elavon, facilitapay, finix, fiserv, fiservemea, fiuu, flexiti, forte, getnet, gigadat, globalpay, globepay, gocardless, gpayments, hipay, helcim, hyperswitch_vault, inespay, iatapay, itaubank, jpmorgan, juspaythreedsserver, klarna, loonio, mifinity, mollie, moneris, multisafepay, netcetera, nexinets, nexixpay, nmi, nomupay, noon, nordea, novalnet, nuvei, opennode, paybox, payload, payme, payone, paypal, paysafe, paystack, paytm, payu, peachpayments, payjustnow, payjustnowinstore, phonepe, placetopay, powertranz, prophetpay, rapyd, razorpay, recurly, redsys, santander, shift4, silverflow, square, stax, stripe, stripebilling, taxjar, threedsecureio, tesouro, tokenex, tokenio, trustpay, trustpayments, tsys, vgs, volt, wellsfargo, wise, worldline, worldpay, worldpayvantiv, worldpayxml, worldpaymodular, signifyd, plaid, riskified, xendit, zen, zift, zsl The id of business profile for this refund
The merchant_connector_id of the processor through which this payment went through
Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refunds initiated against the same payment.
30"ref_mbabizu24mvu3mela5njyhpit4"
An arbitrary string attached to the object
Metadata is useful for storing additional, unstructured information on an object
Show child attributes
Show child attributes
The reference id of the connector for the refund
Contains raw connector response