Refund a transaction
Changed onCreates a refund for a transaction. Partial refunds are not allowed. The amount must equal the original transaction amount received.
Request
- Base URLhttps://apicore.stg.finch.lat
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Client UUID (must match the client_id embedded in the Authorization token).
Transaction UUID to be refunded.
Request body
Example request
{
"amount": "5000.00",
"description": "Invalid amount"
}Response
Refund successfully created
Example response
{
"id": "957459ce-d4e3-40b5-b759-373e844ba1e8",
"bankId": "9d84b03a-28d1-4898-a69c-38824239e2b1",
"clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
"externalReference": "2505091",
"trackingId": "20250510FINCHFL2SFGP9KT",
"description": "Supplier payment",
"amount": "5000.00",
"currency": "MXN",
"category": "DEBIT_TRANS",
"subCategory": "SPEI_DEBIT",
"transactionStatus": "INITIALIZED",
"audit": {
"createdAt": "2025-05-09 18:02:31.979746-06:00",
"updatedAt": "2025-05-09 18:02:31.979746-06:00"
}
}Changes
- breaking
added to the
request propertyallOflist - breaking
the request property
became required - breaking
the request property
became required - breaking
the
request property type changed fromstringto no type - breaking
the
response's property format changed fromdecimalto no format for status - warning
the
request property's maxLength was set to40 - warning
added the new
CANCELLEDenum value to theresponse property for the response status - warning
added the new
CREDIT_TRANSenum value to theresponse property for the response status - warning
added the new
DEBIT_TRANSenum value to theresponse property for the response status - warning
added the new
DECLINEDenum value to theresponse property for the response status - warning
added the new
INITIALIZEDenum value to theresponse property for the response status - warning
added the new
INTER_TRANSenum value to theresponse property for the response status - warning
added the new
INT_ADJ_CREDITenum value to theresponse property for the response status - warning
added the new
INT_ADJ_DEBITenum value to theresponse property for the response status - warning
added the new
INT_CREDITenum value to theresponse property for the response status - warning
added the new
INT_DEBITenum value to theresponse property for the response status - warning
added the new
IN_PROGRESSenum value to theresponse property for the response status - warning
added the new
LIQUIDATEDenum value to theresponse property for the response status - warning
added the new
MXNenum value to theresponse property for the response status - warning
added the new
OTHERenum value to theresponse property for the response status - warning
added the new
OTHERSenum value to theresponse property for the response status - warning
added the new
REFUNDEDenum value to theresponse property for the response status - warning
added the new
REJECTEDenum value to theresponse property for the response status - warning
added the new
SPEI_CREDITenum value to theresponse property for the response status - warning
added the new
SPEI_DEBITenum value to theresponse property for the response status - warning
added the new
SPEI_REFUNDEDenum value to theresponse property for the response status - warning
added the new
SPEI_REFUNDED_CREDITenum value to theresponse property for the response status - warning
added the new
SPEI_REFUNDED_DEBITenum value to theresponse property for the response status - info
api tag
Transactionsadded - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the response property
became required for the status - info
the
response's property pattern^[0-9]+\.[0-9]{2}$was added for the status
- breaking