Payment Refunds
Refunds are used to given back an amount of money to you, it can be used with a payment request ID. Unless otherwise specified, refunds must be requested within 60 days of a settlement.
POST /v1/payments/:id/refund
curl –X POST https://api.firstoken.co/v1/payments/:id/refund' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR API KEY' \
--data '{
"transaction_info": {
"type": "payment_refund",
"reference_code": "123456789"
},
"refund_info": {
"amount_details": {
"total_amount": 1000,
"currency": "COP"
},
"installments": 1
},
"device_info": {
"ip_address": "12.7.8.120"
}
}'
id: string
A valid payment identifier (transaction_id) received in previous requests.
status: string The status is a string result that only has two possible values. "Success, “Error” or "Fail".
message: string The message value represents a short description about the status code.
data: {object} The value of the data represents a set of JSON objects with the transaction’s details:
transaction_info: {object} The wrapper object of the transaction’s information. Contains:
type: string The type of transaction response.
reference_code: string
A reference code for the transaction.
transaction_id: string
Our transaction identifier of the request. It is used in other requests.
request_id: string
The identifier of the request associated with the transaction.
status: string
The status received of the transaction.
reconciliation_id: string The response identifier for reconciliation logs.
created_at: ISO Date
The ISO Date of the request
order_info: {object} The object for the order information sent it in the body request.
amount_details: {object} The total amount details, in this case, the currency.
Last updated
Was this helpful?