In order to start querying the Student Payments REST API you need to contact Transfermate and request the following details:

1. The API URL
2. The Sandbox Credentials (Username/Password)
3. The Secret Key – For verifying the integrity and the authenticity of the response messages.

You need to provide Transfermate with the following information:

1. A Default Webhook URL
   This is the URL to which Transfermate will send payment status updates.
   Please note that if you don’t provide such URL, we won’t be able to notify you when a payment status is updated on our end and you will have to query the Payment History API to get the payment statuses.
   See Webhook Notification Service section for more information.
   
   
2. Settlement Bank Account Details
   We will import your Settlement Bank Account Details into our system and provide you with the Bank Account IDs which you must reference in the MakeAPayment or the FXConversion API call.
   The Base Currency and the settlement process depend on the Bank Account ID which you provide in the API calls.

In the sandbox environment you can use the below Test Bank Account IDs:



There are 4 stages to successfully booking a payment using the Transfermate Education API.

1. Call the FXConversion API endpoint to get a list with available payment methods, the associated charges and the payment flow.
2. Display the payment methods for selection by the student / payer.
3. Call the MakeAPayment API endpoint to register the payment in the Transfermate system.
4. The payment is booked.