Refund your customers from API
Feature activation
To enable this feature on your app, please contact us.
Once a payment is received on the payment account, you can request a refund with the Create a refund request endpoint. You need to provide the payment account transaction ID as the payment_account_transaction_id
parameter.
curl 'https://api.bridgeapi.io/v2/payment-refunds' \
-X POST \
-H 'Bridge-Version: 2021-06-01' \
-H 'Content-Type: application/json' \
-H 'Client-Id: MY_CLIENT_ID' \
-H 'Client-Secret: MY_CLIENT_SECRET' \
-d $'{
"payment_account_transaction_id": "9f7052e8-96cd-45da-8e5c-08c82ef83164",
"amount": 2.0,
"client_reference": "test",
"description": "My product refund description"
}
The payment_account_transaction_id
can be retrieved
- from a payment request:
id
underpayment_account_transaction
intransactions
- from a payment a link:
id
underpayment_account_transactions
infund_information
Once the refund request is created, you can retrieve its status with the Get a single refund request endpoint: Created
, Processing
, In transit
, Paid
, Canceled
, Rejected
, Failed
and Recalled
.
You can list all refund requests created from the dashboard or API using the List of refund requests endpoint.
Updated 9 months ago