Refund Creation Endpoint
Create refunds requests from a completed deposit
Refund Creation
POST
https://api-stg.lime-pay.com/v3/refunds
Description
The refunds
endpoint allows you to create a full refund over a Credit Card deposit in completed state or full/partial refunds over other payment methods' deposits in completed state.
In the case of credit cards, since the refund will be processed to the same card, all you need to send are the fields to identify the deposit.
In the case of other payment methods where we don't have the account of the payer, you need to send the beneficiary's ID, bank account details and bank code retrieved with the Endpoint for Bank Codes.
You can create as many refunds as needed over a completed deposit, as long as the total amount of those refunds doesn't exceed the original amount deposited.
Headers
Request Body
Refunds Request
In order to start creating refunds, you need to:
Send the request with POST method.
Use the headers described here.
Specify a valid
deposit_id
andinvoice_id
related to the deposit to be refunded.Send the Authorization header calculated in the same way than for deposits, as explained here.
Send the body of the request as JSON.
Example Request
Request fields description
bank_account
Object
bank_account
Object