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
Content-Type
string
application/json
X-Date
string
ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
X-Login
string
Merchant X-Login API Key
Authorization
string
Authorization control hash
X-Idempotency-Key
string
Unique idempotency key
Request Body
deposit_id
integer
LimePay deposit_id
. It is obtained when creating the deposit
invoice_id
string
The invoice_id
you sent while creating the deposit or the merchant_invoice_id
auto-generated by us
amount
number
Amount to refund. If none is sent, the full deposit amount is assumed
bank_account
object
Object containing the information of the beneficiary. Not needed for credit cards
comments
string
Commentaries about the refund, if any
notification_url
string
HTTPS URL used to send the notifications about refund's change of status
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
Field
Format
Description
Validations
deposit_id
Integer
Valid deposit_id
of a completed deposit
invoice_id
String (max length: 128)
Valid invoice_id
of a completed deposit
amount
Big decimal (positive, up to 2 decimals)
Amount to refund. Only used in case of partial refunds. If none is sent, a full refund will be assumed
Positive. Equal or smaller than the deposit amount
bank_account[]
Object[]
Object containing the details where the refund should be sent to
comments
String (max length: 200)
Commentaries about the refund, if any
String of up to 200 characters
notification_url
String (max length: 2048)
Valid HTTPS URL used to send the notifications about refund's change of status
HTTPS URL
bank_account
Object
bank_account
ObjectField name
Format
Description
Validations
beneficiary
string (max length: 255)
Beneficiary's name and last name
String of up to 255 characters
document_type
string (max length: 10)
Beneficiary's document type
Valid document type for the country of the deposit.
document
string (max length: 30)
Beneficiary's document ID
Valid document for the country of the deposit.
bank_code
string (max length: 5)
branch
string (max length: 45)
Beneficiary's bank branch
String of up to 45 characters
account_number
string (max length: 45)
Beneficiary's bank account number
String of up to 45 characters
account_type
string (max length: 45)
Beneficiary's account type
Account types
account_type
Description
SAVING
Savings account
CHECKING
Checkings account
VISA
Salary account
MASTER
Master account
SAVING_SET
Joint savings account
CHECKING_SET
Joint checkings
DEFAULT
Default
Example Response
CASH Success Response Example
CASH Success Response Fields
refund_id
Integer
Error Responses Example
Error Responses Fields
Field
Format
Description
code
Integer
description
String
Description of the error
type
String