Refunds API

v4.2.2

/Refunds

POST
https://subdomain.transfermateeducation.com/Refund

Submits refund requests.

Query Params

Parameter ID Example Value Data Type Max Char. Length Range Required Description
username_loginto [username] string 255 Yes API Username
password_loginto [password] string 255 Yes API Password
refund_payment_id 215279 integer - Yes The Payment ID for which the Refund is submitted.
refund_amount 1255.32 float 1.00 - Payment Amount Yes The refund amount.
The value must be bigger than 0.00 and lower or equal to the payment amount.
refund_authoriser_name John Doe string 100 Yes The full name of the refund authorizer
refund_authoriser_email example@example.com string 100 Yes The email address of the authorizer.
The refund instructions will be sent to this email address.
refund_reason Student's visa was cancelled string 250 Yes The reason of the refund request.

Response Examples

XML Response Breakdown

Field Name Field Type Parent Element Return Value Data Type Max Length / Range Description
root Element - - - - The root/parent element.
operation Element root - - - Contains the operation related information.
type Element operation Refunds History string 15 The Request Type.
result Element operation ok, failure string 7 The Request Status result.

ok - The request was successful and you can continue paring the XML response. Please note that, error_code, error_message and field_id elements are not returned if the result is "ok".

failure - There was an error and you should not parse the XML response any further. The error_code, error_message and field_id elements will be returned in the operation element, which can be used to determine what caused the error.
error_code Element operation Integer Number integer 0 - 10000 The error code.
error_message Element operation String - Error Message string 255 The error message.
field_id Element operation String - Field Name string 50 The field_id contains the parameter name which is causing the error.
datetime Element operation YYYY-MM-DDThh:mm:ss+TZ string 30 The date & time of the response in ISO 8601 format.
Example: 2025-02-07T10:51:06+00:00
refund Element root - - - Refund wrapper element
id Attribute refund Integer Number integer - The ID appointed by Transfermate for the current refund request.
id Element refund Integer Number integer - The ID appointed by Transfermate for the current refund request.
payment_id Element refund As provided in the Refund request integer - The Payment ID / Transaction ID for which the refund was requested.
instructions Element refund HTML text Ranges between 500 - 5,000 character The Refund Payment Instructions and Bank Account Details.
The instructions are also sent via email to the Refund Authoriser Email that was provided in the Refund request.
Please note that the length of the payment instructions will vary and may exceed the Max Length value.