curl --request POST \
--url https://sandbox.birrpay.io/refunds \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"amount": 654,
"payment_id": "{{payment_id}}",
"refund_type": "instant"
}
'{
"refund_id": "<string>",
"payment_id": "<string>",
"amount": 6540,
"currency": "<string>",
"status": "succeeded",
"connector": "stripe",
"reason": "<string>",
"metadata": {},
"error_message": "<string>",
"error_code": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"profile_id": "<string>",
"merchant_connector_id": "<string>",
"split_refunds": {
"stripe_split_refund": {
"revert_platform_fee": true,
"revert_transfer": true
}
},
"issuer_error_code": "<string>",
"issuer_error_message": "<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/refunds \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"amount": 654,
"payment_id": "{{payment_id}}",
"refund_type": "instant"
}
'{
"refund_id": "<string>",
"payment_id": "<string>",
"amount": 6540,
"currency": "<string>",
"status": "succeeded",
"connector": "stripe",
"reason": "<string>",
"metadata": {},
"error_message": "<string>",
"error_code": "<string>",
"unified_code": "<string>",
"unified_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"profile_id": "<string>",
"merchant_connector_id": "<string>",
"split_refunds": {
"stripe_split_refund": {
"revert_platform_fee": true,
"revert_transfer": true
}
},
"issuer_error_code": "<string>",
"issuer_error_message": "<string>",
"raw_connector_response": "<string>"
}{
"error_type": "invalid_request",
"message": "Missing required param: {param}",
"code": "IR_04"
}Authorizations
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 to be initiated
30"pay_mbabizu24mvu3mela5njyhpit4"
Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refunds initiated against the same payment. If this is not passed by the merchant, this field shall be auto generated and provided in the API response. It is recommended to generate uuid(v4) as the refund_id.
30"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 full payment amount
x >= 1006540
Reason for the refund. Often useful for displaying to users and your customer support executive. In case the payment went through Stripe, this field needs to be passed with one of these enums: duplicate, fraudulent, or requested_by_customer
255"Customer returned the product"
To indicate whether to refund needs to be instant or scheduled
scheduled, instant You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.
Merchant connector details used to make payments.
Show child attributes
Show child attributes
Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
If true, returns stringified connector raw response body
Response
Refund created
Unique Identifier for the refund
The payment id against which refund is initiated
The refund amount, which should be less than or equal to the total payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc
x >= 1006540
The three-letter ISO currency code
The status for refunds
succeeded, failed, pending, review The connector used for the refund and the corresponding payment
"stripe"
An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive
You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object
The error message
The code for the error
Error code unified across the connectors is received here if there was an error while calling connector
Error message unified across the connectors is received here if there was an error while calling connector
The timestamp at which refund is created
The timestamp at which refund is updated
The id of business profile for this refund
The merchant_connector_id of the processor through which this payment went through
Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Error code received from the issuer in case of failed refunds
Error message received from the issuer in case of failed refunds
Contains whole connector response