Integrate with TransferMate

TransferMate is a global international platform that allows institutions to securely collect and process payments. To enable payments using TransferMate, perform the following tasks:

1. Obtain the TransferMate API credentials
2. Configure the TransferMate gateway

Before you begin

To integrate with DreamApply, your account must have the Superuser role or the accounting-gateways permission.

Obtain the TransferMate API credentials

To start using TransferMate with DreamApply, you need to obtain the following TransferMate API credentials:

• Hostname
• Username
• Password
• HMAC secret key
• Bank Account ID

API credentials are provided by TransferMate as part of the onboarding process. To obtain them, contact the TransferMate team to start the registration process and set up an account.

Configure the TransferMate gateway

To configure a TransferMate payment gateway in DreamApply:

1. In the main menu, under Finance, select Payment gateways.

2. In the gateway list, select TransferMate.

3. Specify the gateway settings:

   1. In the Name field, specify the gateway name. This name will be used for internal reference only and will not be displayed to applicants.

   2. In the Call to action field, specify the text to display on the payment button on financial documents, for example, Pay with TransferMate.

   3. In the Invoice series section, select check boxes next to the invoice series that must be processed through the TransferMate gateway. If a specific series is not selected, DreamApply will not display the payment button on documents that use this series.

      You can link the same invoice series to several payment gateways to allow applicants to choose their preferred payment option.

   4. Specify the API credentials obtained from TransferMate.

   5. In the Currency field, specify the currency set for your Bank Account ID.

4. At the top of the form, click Save changes.

Payment processing

TransferMate follows an asynchronous payment processing model. When an applicant initiates a payment, the confirmation is not sent immediately. TransferMate may take several minutes or even days to finalize the transaction. DreamApply continues checking for the payment status and updates the invoice status as soon as it receives a confirmation from TransferMate.