TransferMate Receivables API Documentation

Receivables API Overview

The Receivables API is designed to allow users to request payments from beneficiaries through a number of API requests.

The Receivables API is a REST API that accepts standard HTTP commands (GET, POST and PUT), returns JSON-encoded responses, and uses standard HTTP response codes. The Receivables service includes pre-defined domain-specific endpoints, such as banks and beneficiaries.

To use the Receivables API, you must be authenticated by verifying your identity.

To help you use the Receivables API, we have provided several use cases to get started and reference information that describes each API request in a consistent manner.

Client Management Overview

Provides a standard way to manage client data, offering the fundamental operations of creating, reading, updating, and deleting client records.

Clients List
Add a Client
Edit a Client
Delete a Client

POST Clients List

Returns a list of clients that are currently added to the account.

Endpoint: /clients_list

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`client_name`	Name of client/ Company	Varchar	-	Yes	-
`client_country`	Country of clients	Varchar	-	Yes	-
`p_number`	Page number of the clients list	Integer	-	Yes	-

Example Request

An example of the JSON structure in the request is as follows:

{
"client_name": "",
"client_country": "",
"p_number": 1
}

Response Body Payload Example

If the request is successful, a list of clients is returned.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`data`	Body of the response. Contains clients in a key value list. The Key is the Id, and value contains further details	List
`id`	Unique ID of the client	Integer
`name`	Name of client/company	Varchar
`email`	Email address of the client/company	Varchar
`currency`	Currency of the client	Varchar
`country`	Country of the client	Varchar
`active`	The active status of a client. 1 is active, 0 is not active	Bit
`actions`	Specifies the actions that you can perform on the account (eg. Edit)	Varchar

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "success": "Action performed successfully."
  },
  "data": {
      "5100": {
          "id": "5100",
          "name": "Test Client Ad6867d",
          "email": "clientmail@somedomain.com",
          "currency": "EUR",
          "country": "Ireland",
          "active": "1",
          "actions": {
              "edit": "Edit",
              "delete": "Delete"
          }
      },
      "5101": {
          "id": "5101",
          "name": "Test Carta LP Mike",
          "email": "clientm3453ail@somedomain.com",
          "currency": "EUR",
          "country": "Ireland",
          "active": "1",
          "actions": {
              "edit": "Edit"
          }
      }
  }
}

Add a Client

Allows a user to add a client

Endpoint: /add_client

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`client_type`	Type of client. The options are: Corporate 23 or Individual 3	Integer	-	Yes	-
`company_name`	Name of the company/client	Varchar	-	Yes(if client_type is 23)	-
`email`	Email address associated with the company/client	Varchar	-	Yes	-
`first_name`	First name of an individual client	Varchar	255	Yes(if client_type 3)	-
`last_name`	Last name of an individual client	Varchar	255	Yes(if client_type 3)	-
`mobile_number_international_dialing_code`	International dialling code for companies/ clients mobile number (See Country Codes)	Varchar	-	Yes	-
`mobile_number_mobile_phone`	Mobile number of the company/client	Varchar	-	Yes	-
`country_id`	ID of companies/ clients country (See Country Reference by System ID)	Varchar	-	Yes	-
`state`	State of company/client	Varchar	-	No (unless in USA/Canada)	-
`currency_type_id`	Currency of company client (See Currency Codes)	Varchar	-	Yes	-
`def_request_reason_id`	Reason ID for the request. (See Reason Codes)	Varchar	-	Yes	-
`ledger_code`	Ledger code of the client	Varchar	-	Yes	-
`website_address`	Address of clients website	Varchar	255	No	-

Example Request

An example of the JSON structure in the request with a Corporate client:

{
"client_type": 23,
  "company_name": "Test Client Add",
  "email": "client-add-demo@transfermate.com",
  "mobile_number_international_dialing_code": "ie 353",
  "mobile_number_mobile_phone": "1234567",
  "country_id": 113,
  "state": "",
  "currency_type_id": "EUR",
  "default_lng": "en",
  "def_request_reason_id": "",
  "ledger_code": "",
  "website_address": ""
}

An example of the JSON structure in the request with an Individual client:

{
"client_type": 3,
  "first_name": "bill",
  "last_name": "blooth",
  "email": "bill@transfermate.com",
  "__mobile_number_international_dialing_code": "ie 353",
  "__mobile_number_mobile_phone": "1234567",
  "country_id": 113, "state": "",
  "currency_type_id": "EUR",
  "default_lng": "en",
  "def_request_reason_id": "",
  "ledger_code": ""
}

Response Body Payload Example

If the request is successful, a response with the newly created clients Id.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	message(s) about the request	List
`id`	Unique ID of the client	Integer

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
"messages": {
      "success": "Action performed successfully."
  },
  "id": 4143
}

POST Edit a Client

Allows a user to edit a client

Endpoint: /edit_client

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`id`	ID of client to delete	Integer	-	Yes	-
`client_type`	Type of client - Corp: 23, Partnership: 70, Sole Trader: 71, Individual: 3	Integer	-	Yes	-
`company_name`	Name of the company/client	Varchar	-	Yes	-
`email`	Email address associated with the company/client	Varchar	-	Yes	-
`email`	Email address associated with the company/client	Varchar	-	Yes	-
`mobile_number_international_dialing_code`		Varchar	-	Yes	-
`mobile_number_mobile_phone`	Mobile number of the company/client	Varchar	-	Yes	-
`country_id`	ID of companies/ clients country (See Country Reference by System ID)	Varchar	-	Yes	-
`state`	State of company/client	Varchar	-	No (unless in USA/Canada)	-
`currency_type_id`	Currency of company client (See Currency Codes)	Varchar	-	Yes	-
`default_lng`	Default language of company/client	Varchar	-	No	en
`website_address`	Address of clients website	Varchar	255	No	-
`active`	Active state of the client. 1 for active. 0 to disable them.	Bit	-	Yes	-

Example Request

An example of the JSON structure in the request is as follows:

{
"id": 4141,
  "client_type": 23,
  "company_name": "Test Client Edit",
  "email": "client-add-demo@transfermate.com",
  "mobile_number_international_dialing_code": "ie 353",
  "mobile_number_mobile_phone": "1234567",
  "country_id": 113,
  "state": "",
  "currency_type_id": "EUR",
  "default_lng": "en",
  "website_address": "",
  "active": 1
}

Response Body Payload Example

If the request is successful, a message in returned with more details about the success of editing the client.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	message(s) about the request	List

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "success": "Action performed successfully."
  }
}

POST Delete a Client

Allows a user to delete a client

Endpoint: /delete_client

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`id`	ID of client to delete	Integer	-	Yes	-

Example Request

An example of the JSON structure in the request is as follows:

{
"id": 5101
}

Response Body Payload Example

If the request is successful, a message in returned with more details about the success of removing the client.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	message(s) about the request	List

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
"messages": {
"4142": "The client was successfully deleted!"
}
}

Payment Management Overview

Offers a streamlined approach to managing the lifecycle of payments, enabling you to request a payment, subsequently authorize it, cancel it if needed, or retrieve a list of payments along with their individual details.

Request a Payment
Payment Requests List
Cancel a Payment Request
Authorize a Payment Request
Payment Request Details

POST Request a Payment

Sends a request to an existing client for a payment. Multiple payment requests can be sent.

Endpoint: /request_payment

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`client_data`	A list of client payment attribute groups	List	-	Yes	-
`id`	ID of the client to send the request to	Integer	-	Yes	-
`statement_of_account_currency`	Currency of client	Varchar	-	Yes	-
`debtor_balance`	Balance to be paid by the client	Decimal	-	Yes	-
`request_reason_id`	Number value for the request reason. (See Transfer Reasons)	Integer	-	Yes	-
`invoice_reference`	Custom identifier for the invoice	Varchar	-	Yes	-
`due_date`	Date that the payment is due to made by	Date	-	Yes	-
`statement_account`	-	Varchar	-	No	-

Example Request

An example of the JSON structure in the request is as follows:

{
"clients_data": [
      {
          "id": 4143,
          "statement_of_account_currency": "EUR",
          "debtor_balance": 1000,
          "request_reason_id": 7,
          "invoice_reference": "REF5546J3",
          "due_date": "24/06/2022",
          "statement_account": ""
      }
  ]
}

Response Body Payload Example

If the request is successful, details about the payment request are returned.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	message(s) about the request	Object
`id`	Unique ID of the payment	Integer

Example Success Response

{
"is_successful": true,
  "messages": {
      "success": "Action performed successfully."
  },
  "id": 13717
}

POST Payment Requests List

Returns back a list of payment requests that have been made.

Endpoint: /payment_requests_list

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`invoice_currency`	Currency of the payment request.	Varchar	-	Yes	-
`customer_name`	Name of the client/ customer	Varchar	-	Yes	-
`invoices_statuses_id`	Status of payment request.	Varchar	-	Yes	-
`batch_upload_file_id`	ID of the batch upload	Varchar	-	Yes	-
`date_from`	Specifies the start date of the period for which you want to retrieve payment requests	Date	-	Yes	-
`date_to`	Specifies the end date of the period for which you want to retrieve payment requests	Date	-	Yes	-
`due_date_from`	Specifies the start date of the due dates for the payment requests you want to retrieve	Date	-	Yes	-
`due_date_to`	Specifies the end date of the due dates for the payment requests you want to retrieve	Date	-	Yes	-
`date_paid_from`	Specifies the start date of the paid dates for the payment requests you want to retrieve	Date	-	Yes	-
`date_paid_to`	Specifies the end date of the paid dates for the payment requests you want to retrieve	Date	-	Yes	-
`p_number`	Page number of payment requests	Integer	-	Yes	-

Example Request

An example of the JSON structure in the request is as follows:

{
"invoice_currency": "",
  "customer_name": "",
  "invoices_statuses_id": "",
  "batch_upload_file_id": "",
  "date_from": "",
  "date_to": "",
  "due_date_from": "",
  "due_date_to": "",
  "date_paid_from": "",
  "date_paid_to": "",
  "p_number": 1
}

Response Body Payload Example

If the request is successful, a list of payment requests is returned.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	message(s) about the request	Object
`page`	Page number of payment requests	Integer
`pages_count`	Number of pages	Integer
`total_records`	Total payment list	Integer
`csv_export_url`	Link to download payments request list in CSV file format	Varchar
`xls_export_url`	Link to download payments request list in XLS format	Varchar
`data`	List of payment requests. ID used as identifier for each object in list	List
`id`	Unique ID of the payment request	Integer
`date_submitted`	Date/ time the payment was submitted	Date
`date_paid`	Date/ time the payment was paid	Date
`currency`	Currency of the payment	Varchar
`amount_to_pay`	Amount the payment request is for.	Varchar
`invoice_reference`	Invoice reference set by the user when making the payment request.	Varchar
`request_reason`	Request reason set at the time of request.	Varchar
`client_name`	Name of client/company	Varchar
`due_date`	Date the payment request is due to be paid on.	Date
`days_overdue`	Day the payment is past the due date.	Integer
`status`	Status of the payment	Varchar
`select`		Object
`inv_url`	URL to send to invite people to make the payment.	Varchar

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "success": "Action performed successfully."
  },
  "page": 1,
  "pages_count": 13,
  "total_records": 124,
  "csv_export_url": "https://dev-test-internationalpayment-com.xmlint.ssl443.net/data_export",
  "xls_export_url": "https://dev-test-internationalpayment-com.xmlint.ssl443.net/data_export.asp?exp=InvoicesSummaryApp&tp=csv&dummy=20200624155659",
  "data": {
      "6719": {
          "id": "6719",
          "date_submitted": "2020-06-22 09:23:17",
          "date_paid": "",
          "currency": "EUR",
          "amount_to_pay": "1000.00",
          "invoice_reference": "REF5546J3",
          "request_reason": "Bill payment",
          "client_name": "NAsko",
          "due_date": "2022-06-24",
          "days_overdue": "",
          "status": "Sending Invoice",
          "select": {
              "inputs": {
                  "invoice_id13604": {
                      "type": "checkbox",
                      "id": "invoice_id13604",
                      "name": "invoice_id13604",
                      "label": "",
                      "value": 1,
                      "checked": 0
                  }
              }
          },
          "inv_url": "https://transfermate.com/en/receivables-payment-portal?id=12573&code=ee73bd781da115cbc70b24351f0acb820c0632f16d"
      }
  }
}

POST Cancel a Payment Request

This request can be used to delete a single or multiple payment requests.

Endpoint: /cancel_payment_request

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`invoice_id`	ID of the invoice(s) to cancel	List	-	Yes	-

Example Request

An example of the JSON structure in the request is as follows:

{
"invoice_id": [
6718
]
}

Response Body Payload Example

If the request is successful, the payment(s) will be cancelled and a message will be retured to let the user know.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	Message for the success/ failure of the payment request.	Object
`id`	Unique ID of the payment	Integer

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
"messages": {
"45550": "The action was performed successfully!"
}
}

POST Authorize a Payment Request

This request can be used to authorize a single or multiple payment requests.

Endpoint: /authorize_payment_request

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`invoice_id`	ID of the invoice(s) to authorize	List	-	Yes	-

Example Request

An example of the JSON structure in the request is as follows:

{
"invoice_id": [
653
]
}

Response Body Payload Example

If the request is successful, the payment(s) will be authorized and a message will be retured to let the user know.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	Message for the success/ failure of the payment request.	Object
`id`	Unique ID of the payment	Integer
`inv_url`	Invite URL to send to payees to make the payment.	Varchar
`api_url`	This URL is unique to each biller.	Varchar
`code`	Invoice code.	Varchar

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "info": "The action was performed successfully!"
  },
  "inv_url": "https://testurl.com/en/receivables-payment-portal?id=24519&code=de32e5d1dc18da1b349874cc6951a88cff50970ca33cbb00318cb1efb1150d97",
  "api_url": "https://testurl.transfermate.com/app/",
  "id": 185444,
  "code": "de32e5d1dc18da1b349874cc6951a88cff54487ca33cbb00318cb1efb1150d97"
}

POST Payment Request Details

This request can be used to retrieve details of payment requests.

Endpoint: /payment_request_details

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`invoice_id`	ID of the invoice(s) to retrieve details of	List	-	Yes	-

Example Request

An example of the JSON structure in the request is as follows:

{
"invoice_id": [
4444
]
}

Response Body Payload Example

If the request is successful, details about that specific payment request are returned.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	Message for the success/ failure of the payment request.	Object
`id`	Unique ID of the payment	Integer
`date_submitted`	Date of payment request	Date
`date_paid`	Date of payment	Date
`currency`	Currency of the payment	Varchar
`amount_to_pay`	Amount requested to pay	Varchar
`invoice_reference`	Reference for the payment request	Varchar
`request_reason`	Reason for the payment request	Varchar
`client_name`	Name of client	Varchar
`requested_by`	Name of user that made the request	Varchar
`due_date`	Date payment is due by	Date
`transfer_type`	Type of transfer requested, eg. Direct Debit, Bank Transfer	Varchar
`status`	Status of the payment request	Varchar
`ledger_code`		Varchar
`inv_url`	Invite URL to send to payees to make the payment.	Varchar

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "success": "Action performed successfully."
  },
  "id": "13167",
  "date_submitted": "2021-05-14 12:18:51",
  "date_paid": "",
  "currency": "EUR",
  "amount_to_pay": "3000.00",
  "invoice_reference": "Ref3412",
  "request_reason": "Bill payment",
  "client_name": "Mapping Test_seven",
  "requested_by": "Test", "due_date": "2020-11-12",
  "days_overdue": "143",
  "transfer_type": "",
  "status": "Awaiting Authorization",
  "ledger_code": "abcd0031",
  "inv_url": ""
}

POST Payment Portal Rates (Guest)

This request is used to receive a rate for an invoice in a specified currency. This is for a non registered user.

Endpoint: /payment-portal-rate-guest

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`id`	ID of the invoice in question	Integer	-	Yes	-
`code`	Code of the invoice, this can be gotten from the URL in the authorize call response.	Varchar	-	Yes	-
`country_id`	System ID of the country you will be making the payment from (See Country Reference by System ID)	Integer	-	Yes	-
`currency_type_id_from`	Currency ID that the payment will be made from	Varchar	-	Yes	-

Example Request

The JSON structure in a successful request is as follows:

{
"id": "12086",
  "code": "24a84d0896ce5db1f08508c5e623cba3f787c5a68446f6d5e95eab29b0cee793",
  "country_id": "113",
  "currency_type_id_from": "EUR"
}

Response Body Payload Example

If the request is successful, information about rates for the payment request is returned.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`invoice_data`	Data relating to the invoice	List
`id`	Unique ID of the invoice	Integer
`currency_type_id`	Type of currency the request was made in	Varchar
`amount_to_pay`	Amount in requested currency.	Decimal
`invoice_reference`	Reference associated with the invoice	Varchar
`country_id`	Country where the invoice originated.	Varchar
`request_reason_id`	Reason for payment request (list)	Integer
`rates_data`	Information regarding the exchange of the given currency.	List
`currency_from`	Currency given in the request	Varchar
`currency_to`	Currency of the invoice to be paid	Varchar
`amount_from_before_fee`	Amount to be paid in domestic currency	Decimal
`fee_total_amount`	Fee amount for the transaction	Decimal
`amount_from_aft_fee`	Combined amount of both the amount to be paid and fee	Decimal
`amount_to`	Amount in foreign currency	Decimal
`rate_per_unit`	Rate per unit	Float
`count_back_sec`	Time that this rate is valid for	Decimal

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "data": "No data found.",
      "step_num__stepcn": ""
  },
  "data": {},
  "invoice_data": {
  "id": 12086,
  "currency_type_id": "EUR",
  "amount_to_pay": "1000.00",
  "invoice_reference": "REF5546J3",
  "country_id": 79,
  "request_reason_id": 13
  },
  "rates_data": {
      "currency_from": "USD",
      "currency_to": "EUR",
      "amount_from_before_fee": "1237.47",
      "fee_total_amount": "0.00",
      "amount_from_after_fee": "1237.47",
      "amount_to": "1000.51",
      "rate_per_unit": "0.80851",
      "count_back_sec": 91
  }
}

POST Payment Portal Pay (Guest Individual)

This request is for paying an invoice as a guest individual.

Endpoint: /payment-portal-pay-guest-individual

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`id`	ID of the invoice in question.	Integer	-	Yes	-
`code`	Code of the invoice	Varchar	-	Yes	-
`country_id`	System ID of the country you will be making the payment from (See Country Reference by System ID)	Varchar	-	Yes	-
`currency_type_id_from`	Currency ID that the payment will be made from	Varchar	-	Yes	-
`first_name`	First name of the individual making the payment	Varchar	-	Yes	-
`middle_name`	Middle name of the individual making the payment	Varchar	-	Yes	-
`last_name`	Last name of the individual making the payment	Varchar	-	Yes	-
`country`	Country of individual using system id	Varchar	-	Yes	-
`state`	State of individual	Varchar	-	Yes(Only for USA and Canada)	-
`address_line_1`	Address line 1	Varchar	-	Yes	-
`address_line_2`	Address line 2	Varchar	-	Yes	-
`city`	City of the individual	Varchar	-	No	-
`region`	Region of individual	Varchar	-	No	-
`date_of_birth`	Date of birth. dd/mm/yyyy format	Date	-	Yes	-
`post_code_zip`	Post code or ZIP	Varchar	-	Yes	-
`email`	Email address of individual	Varchar	-	Yes	-
`international_dialing_code`	International dialing code. See list	Varchar	-	Yes	-
`mobile_phone`	Mobile phone number of the individual	Varchar	-	Yes	-
`complete_payment`	Indicates if the payment is being paid in full.	Integer	-	Yes	1

Example Request

An example of the JSON structure in the request is as follows:

{
"id": "7241",
  "code": "4ae6e4010bb5f6e80400255029f1e15230b21bfea843190a62aa9bf46fb9273c",
  "country_id": "113",
  "currency_type_id_from": "HRK",
  "first_name": "Test",
  "middle_name": "Test",
  "last_name": "Test",
  "country": "247",
  "state": "",
  "address_line_1": "Test",
  "address_line_2": "Test",
  "city": "Test",
  "region": "Test",
  "date_of_birth": "20/03/2003",
  "post_code_zip": "Test123",
  "email": "Test@test123.123",
  "international_dialing_code": "ro 40",
  "mobile_phone": "123456789",
  "is_test": "1",
  "complete_payment": "1"
}

Example Success Response

If the request is successful, details about the payment is returned.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	A list of messages relating to the next steps to complete the payment	List
`invoice_data`	Data relating to the invoice	List
`id`	Unique ID of the invoice	Integer
`currency_type_id`	Type of currency the request was made in	Varchar
`amount_to_pay`	Amount in requested currency.	Varchar
`invoice_reference`	Reference associated with the invoice	Varchar
`country_id`	Country where the invoice originated.	Varchar
`request_reason_id`	Reason for payment request (list)	Integer
`rates_data`	Information regarding the exchange of the given currency.	List
`currency_from`	Currency given in the request	Varchar
`currency_to`	Currency of the invoice to be paid	Varchar
`amount_from_before_fee`	Amount to be paid in domestic currency	Decimal
`fee_total_amount`	Fee amount for the transaction	Decimal
`amount_from_after_fee`	Combined amount of both the amount to be paid and fee	Decimal
`amount_to`	Amount in foreign currency	Decimal
`rate_per_unit`	Rate Per Unit	Float
`count_back_sec`	Time that this rate is valid for	Decimal
`pay_details`	List of payment details for the payment	List
`transfer_type`	The type of transfer that	Varchar
`currency`	Currency that the payment is being made in	Varchar
`amount`	Amount to be pay	Varchar
`particular`	First and last name of the user	Varchar
`account_name`	Account name of the bank to be paid	Varchar
`bank_name`	Name of bank for be paid	Varchar
`bank_country`	Country of bank	Varchar
`bank_address`	Address of the bank.	Varchar
`account_number`	Account number of bank.	Varchar
`aba_number`	ABA routing number of the bank.	Varchar
`ref_number`	Reference number of the payment.	Varchar

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "rec_auth_point_1": "Complete a wire transfer to our account using the details provided below, within 48 hours.",
      "rec_auth_point_2": "To avoid extra costs please send Croatia Kuna (HRK) only, via wire transfer. Cash, drafts or cheques will not be accepted.",
      "rec_auth_point_3": "Please ensure that you enter the Reference Number."
  },
  "invoice_data": {
      "id": 7241,
      "currency_type_id": "USD",
      "amount_to_pay": "25000.00",
      "invoice_reference": "1234",
      "country_id": 113,
      "request_reason_id": 7
  },
  "rates_data": {
      "currencyFrom": "HRK",
      "currencyTo": "USD",
      "amountFromBeforeFee": "158498.70",
      "feeTotalAmountFrom": "70.00",
      "amountFromAfterFee": "158568.70",
      "amountTo": "25000.00",
      "ratePerUnit": "0.15773",
      "countBackSec": 91
  },
  "pay_details": {
      "transfer_type": "International Bank Transfer",
      "currency": "HRK",
      "amount": "HRK 158568.70",
      "particular": "",
      "account_name": "Interpay Limited",
      "bank_name": "BARCLAYS BANK PLC",
      "bank_country": "United Kingdom",
      "iban": "GB15BARC20850889177955",
      "account_number": "89177955",
      "sort_code": "208508",
      "swift_bic": "BARCGB22",
      "ref_number": "B1135558"
  }
}

POST Payment Portal Pay (Guest Corporate)

This request is for paying an invoice as a corporate guest.

Endpoint: /payment-portal-pay-guest-corporate

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`id`	ID of the invoice in question.	Integer	-	Yes	-
`code`	Code of the invoice	Varchar	-	Yes	-
`country_id`	System ID of the country you will be making the payment from (See Country Reference by System ID)	Varchar	-	Yes	-
`currency_type_id_from`	Currency ID that the payment will be made from	Varchar	-	Yes	-
`company_name`	The name of the company	Varchar	-	Yes	-
`company_reg_number`	Company registration number	Varchar	-	Yes	-
`country`	Country of individual using system id	Varchar	-	Yes	-
`state`	State of individual	Varchar	-	Yes(Only for USA and Canada)	-
`address_line_1`	Address line 1	Varchar	-	Yes	-
`address_line_2`	Address line 2	Varchar	-	Yes	-
`city`	City of the individual	Varchar	-	No	-
`region`	Region of individual	Varchar	-	No	-
`date_of_birth`	Date of birth. dd/mm/yyyy format	Date	-	No	-
`post_code_zip`	Post code or ZIP	Varchar	-	Yes	-
`email`	Email address of individual	Varchar	-	Yes	-
`international_dialing_code`	International dialing code. See list	Varchar	-	Yes	-
`mobile_phone`	Mobile phone number of the individual	Varchar	-	Yes	-
`complete_payment`	Indicates if the payment is being paid in full.	Integer	-	Yes	1

Example Request

The JSON structure in a successful response is as follows:

{
"id": "7241",
  "code": "4ae6e4010bb5f6e80400255029f1e15230b21bfea843190a62aa9bf46fb9273c",
  "country_id": "113",
  "currency_type_id_from": "HRK",
  "company_name": "Test",
  "company_reg_number": "",
  "country": "247",
  "state": "",
  "address_line_1": "Test",
  "address_line_2": "Test",
  "city": "Test",
  "region": "Test",
  "post_code_zip": "98603",
  "email": "Test@test123.123",
  "international_dialing_code": "ro 40",
  "mobile_phone": "123456789",
  "is_test": "1",
  "complete_payment": "1"
}

Response Body Payload Example

If the request is successful, details about the payment is returned.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	A list of messages relating to the next steps to complete the payment	List
`invoice_data`	Data relating to the invoice	List
`id`	Unique ID of the invoice	Integer
`currency_type_id`	Type of currency the request was made in	Varchar
`amount_to_pay`	Amount in requested currency.	Varchar
`invoice_reference`	Reference associated with the invoice	Varchar
`country_id`	Country where the invoice originated.	Varchar
`request_reason_id`	Reason for payment request (list)	Integer
`rates_data`	Information regarding the exchange of the given currency.	List
`currency_from`	Currency given in the request	Varchar
`currency_to`	Currency of the invoice to be paid	Varchar
`amount_from_before_fee`	Amount to be paid in domestic currency	Decimal
`fee_total_amount`	Fee amount for the transaction	Decimal
`amount_from_after_fee`	Combined amount of both the amount to be paid and fee	Decimal
`amount_to`	Amount in foreign currency	Decimal
`rate_per_unit`	Rate Per Unit	Float
`count_back_sec`	Time that this rate is valid for	Decimal
`pay_details`	List of payment details for the payment	List
`transfer_type`	The type of transfer that	Varchar
`currency`	Currency that the payment is being made in	Varchar
`amount`	Amount to be pay	Varchar
`particular`	First and last name of the user	Varchar
`account_name`	Account name of the bank to be paid	Varchar
`bank_name`	Name of bank for be paid	Varchar
`bank_country`	Country of bank	Varchar
`bank_address`	Address of the bank.	Varchar
`account_number`	Account number of bank.	Varchar
`aba_number`	ABA routing number of the bank.	Varchar
`ref_number`	Reference number of the payment.	Varchar

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "rec_auth_point_1": "Complete a wire transfer to our account using the details provided below, within 48 hours.",
      "rec_auth_point_2": "To avoid extra costs please send Croatia Kuna (HRK) only, via wire transfer. Cash, drafts or cheques will not be accepted.",
      "rec_auth_point_3": "Please ensure that you enter the Reference Number."
  },
  "invoice_data": {
      "id": 13722,
      "currency_type_id": "EUR",
      "amount_to_pay": "1000.51",
      "invoice_reference": "Test1",
      "country_id": 113,
      "request_reason_id": 7
  },
  "rates_data": {
      "currency_from": "USD",
      "currency_to": "EUR",
      "amount_from_before_fee": "1237.47",
      "fee_total_amount": "0.00",
      "amount_from_after_fee": "1237.47",
      "amount_to": "1000.51",
      "rate_per_unit": "0.80851",
      "count_back_sec": 91
  },
  "pay_details": {
      "transfer_type": "International Bank Transfer",
      "currency": "HRK",
      "amount": "HRK 7693.51",
      "particular": "",
      "account_name": "Interpay Limited",
      "bank_name": "BARCLAYS BANK PLC",
      "bank_country": "United Kingdom",
      "iban": "GB15BARC20850889177955",
      "account_number": "89177955",
      "sort_code": "208508",
      "swift_bic": "BARCGB22",
      "ref_number": "B1135462"
  }
}

POST Payment Portal Pay (Guest Partnership)

This request is for paying an invoice as a guest partner.

Endpoint: /payment-portal-pay-guest-soletrader

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`id`	ID of the invoice in question.	Integer	-	Yes	-
`code`	Code of the invoice	Varchar	-	Yes	-
`country_id`	System ID of the country you will be making the payment from (See Country Reference by System ID)	Varchar	-	Yes	-
`currency_type_id_from`	Currency ID that the payment will be made from	Varchar	-	Yes	-
`company_name`	The name of the company	Varchar	-	Yes	-
`company_reg_number`	Company registration number	Varchar	-	Yes	-
`country`	Country of individual using system id	Varchar	-	Yes	-
`state`	State of individual	Varchar	-	Yes(Only for USA and Canada)	-
`address_line_1`	Address line 1	Varchar	-	Yes	-
`address_line_2`	Address line 2	Varchar	-	Yes	-
`city`	City of the individual	Varchar	-	No	-
`region`	Region of individual	Varchar	-	No	-
`date_of_birth`	Date of birth. dd/mm/yyyy format	Date	-	No	-
`post_code_zip`	Post code or ZIP	Varchar	-	Yes	-
`email`	Email address of individual	Varchar	-	Yes	-
`international_dialing_code`	International dialing code. See list	Varchar	-	Yes	-
`mobile_phone`	Mobile phone number of the individual	Varchar	-	Yes	-
`complete_payment`	Indicates if the payment is being paid in full.	Integer	-	Yes	1

Example Request

The JSON structure in a successful response is as follows:

{
"id": "7241",
  "code": "4ae6e4010bb5f6e80400255029f1e15230b21bfea843190a62aa9bf46fb9273c",
  "country_id": "113",
  "currency_type_id_from": "HRK",
  "company_name": "Test",
  "company_reg_number": "",
  "country": "247",
  "state": "",
  "address_line_1": "Test",
  "address_line_2": "Test",
  "city": "Test",
  "region": "Test",
  "post_code_zip": "Test",
  "email": "Test@Test.Test",
  "international_dialing_code": "ro 40",
  "mobile_phone": "123456789",
  "is_test": "1",
  "complete_payment": "1"
}

Response Body Payload Example

If the request is successful, details about the payment are returned.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	A list of messages relating to the next steps to complete the payment	List
`invoice_data`	Data relating to the invoice	List
`id`	Unique ID of the invoice	Integer
`currency_type_id`	Type of currency the request was made in	Varchar
`amount_to_pay`	Amount in requested currency.	Varchar
`invoice_reference`	Reference associated with the invoice	Varchar
`country_id`	Country where the invoice originated.	Varchar
`request_reason_id`	Reason for payment request (list)	Integer
`rates_data`	Information regarding the exchange of the given currency.	List
`currency_from`	Currency given in the request	Varchar
`currency_to`	Currency of the invoice to be paid	Varchar
`amount_from_before_fee`	Amount to be paid in domestic currency	Decimal
`fee_total_amount`	Fee amount for the transaction	Decimal
`amount_from_after_fee`	Combined amount of both the amount to be paid and fee	Decimal
`amount_to`	Amount in foreign currency	Decimal
`rate_per_unit`	Rate Per Unit	Float
`count_back_sec`	Time that this rate is valid for	Decimal
`pay_details`	List of payment details for the payment	List
`transfer_type`	The type of transfer that	Varchar
`currency`	Currency that the payment is being made in	Varchar
`amount`	Amount to be pay	Varchar
`particular`	First and last name of the user	Varchar
`account_name`	Account name of the bank to be paid	Varchar
`bank_name`	Name of bank for be paid	Varchar
`bank_country`	Country of bank	Varchar
`bank_address`	Address of the bank.	Varchar
`account_number`	Account number of bank.	Varchar
`aba_number`	ABA routing number of the bank.	Varchar
`ref_number`	Reference number of the payment.	Varchar

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "rec_auth_point_1": "Complete a wire transfer to our account using the details provided below, within 48 hours.",
      "rec_auth_point_2": "To avoid extra costs please send Croatia Kuna (HRK) only, via wire transfer. Cash, drafts or cheques will not be accepted.",
      "rec_auth_point_3": "Please ensure that you enter the Reference Number."
  },
  "invoice_data": {
      "id": 13736,
      "currency_type_id": "EUR",
      "amount_to_pay": "1000.51",
      "invoice_reference": "Test1",
      "country_id": 113,
      "request_reason_id": 7
  },
  "rates_data": {
      "currency_from": "USD",
      "currency_to": "EUR",
      "amount_from_before_fee": "1237.47",
      "fee_total_amount": "0.00",
      "amount_from_after_fee": "1237.47",
      "amount_to": "1000.51",
      "rate_per_unit": "0.80851",
      "count_back_sec": 91
  },
  "pay_details": {
      "transfer_type": "International Bank Transfer",
      "currency": "HRK",
      "amount": "HRK 7691.77",
      "particular": "",
      "account_name": "Interpay Limited",
      "bank_name": "BARCLAYS BANK PLC",
      "bank_country": "United Kingdom",
      "iban": "GB15BARC20850889177955",
      "account_number": "89177955",
      "sort_code": "208508",
      "swift_bic": "BARCGB22",
      "ref_number": "B1135462"
  }
}

POST Payment Portal Pay (Guest Sole Trader)

This request is for paying an invoice as a guest sole trader.

Endpoint: /payment-portal-pay-guest-soletrader

Request Body Payload Example

The request body includes the following parameters:

Parameter	Description	Type	Size	Mandatory	Default Value
`id`	ID of the invoice in question.	Integer	-	Yes	-
`code`	Code of the invoice	Varchar	-	Yes	-
`country_id`	System ID of the country you will be making the payment from (See Country Reference by System ID)	Varchar	-	Yes	-
`currency_type_id_from`	Currency ID that the payment will be made from	Varchar	-	Yes	-
`first_name`	First name of the individual making the payment	Varchar	-	Yes	-
`middle_name`	Middle name of the individual making the payment	Varchar	-	Yes	-
`last_name`	Last name of the individual making the payment	Varchar	-	Yes	-
`country`	Country of individual using system id	Varchar	-	Yes	-
`state`	State of individual	Varchar	-	Yes(Only for USA and Canada)	-
`address_line_1`	Address line 1	Varchar	-	Yes	-
`address_line_2`	Address line 2	Varchar	-	Yes	-
`city`	City of the individual	Varchar	-	No	-
`region`	Region of individual	Varchar	-	No	-
`date_of_birth`	Date of birth. dd/mm/yyyy format	Date	-	Yes	-
`post_code_zip`	Post code or ZIP	Varchar	-	Yes	-
`email`	Email address of individual	Varchar	-	Yes	-
`international_dialing_code`	International dialing code. See list	Varchar	-	Yes	-
`mobile_phone`	Mobile phone number of the individual	Varchar	-	Yes	-
`complete_payment`	Indicates if the payment is being paid in full.	Integer	-	Yes	1

Example Request

An example of the JSON structure in the request is as follows:

{
"id": "7241",
  "code": "4ddd16310f7c2f3ccb41af9faace267eb1ae2ce4e47a25abf2874d5a96887a83",
  "country_id": "113",
  "currency_type_id_from": "HRK",
  "first_name": "joe",
  "middle_name": "",
  "last_name": "blogg",
  "country": "247",
  "state": "",
  "address_line_1": "Huber and Blair Associates",
  "address_line_2": "Schultz and Petersen Inc",
  "city": "Blevins and Wade Co",
  "region": "region/state/country",
  "date_of_birth": "20/03/2003",
  "post_code_zip": "98603",
  "email": "datopalov1dfgd7@transfermate.com",
  "international_dialing_code": "ro 40",
  "mobile_phone": "15927812896",
  "is_test": "1",
  "complete_payment": "1"
}

Response Body Payload Example

If the request is successful, details about the payment is returned.

The response body includes the following parameters:

FIELD	DESCRIPTION	TYPE
`is_successful`	Status of the request	Boolean
`messages`	A list of messages relating to the next steps to complete the payment	List
`invoice_data`	Data relating to the invoice	List
`id`	Unique ID of the invoice	Integer
`currency_type_id`	Type of currency the request was made in	Varchar
`amount_to_pay`	Amount in requested currency.	Varchar
`invoice_reference`	Reference associated with the invoice	Varchar
`country_id`	Country where the invoice originated.	Varchar
`request_reason_id`	Reason for payment request (list)	Integer
`rates_data`	Information regarding the exchange of the given currency.	List
`currency_from`	Currency given in the request	Varchar
`currency_to`	Currency of the invoice to be paid	Varchar
`amount_from_before_fee`	Amount to be paid in domestic currency	Decimal
`fee_total_amount`	Fee amount for the transaction	Decimal
`amount_from_after_fee`	Combined amount of both the amount to be paid and fee	Decimal
`amount_to`	Amount in foreign currency	Decimal
`rate_per_unit`	Rate Per Unit	Float
`count_back_sec`	Time that this rate is valid for	Decimal
`pay_details`	List of payment details for the payment	List
`transfer_type`	The type of transfer that	Varchar
`currency`	Currency that the payment is being made in	Varchar
`amount`	Amount to be pay	Varchar
`particular`	First and last name of the user	Varchar
`account_name`	Account name of the bank to be paid	Varchar
`bank_name`	Name of bank for be paid	Varchar
`bank_country`	Country of bank	Varchar
`bank_address`	Address of the bank.	Varchar
`account_number`	Account number of bank.	Varchar
`aba_number`	ABA routing number of the bank.	Varchar
`ref_number`	Reference number of the payment.	Varchar

Example Success Response

The JSON structure in a successful response is as follows:

{
"is_successful": true,
  "messages": {
      "rec_auth_point_1": "Complete a wire transfer to our account using the details provided below, within 48 hours.",
      "rec_auth_point_2": "To avoid extra costs please send Croatia Kuna (HRK) only, via wire transfer. Cash, drafts or cheques will not be accepted.",
      "rec_auth_point_3": "Please ensure that you enter the Reference Number."
  },
  "invoice_data": {
      "id": 13625,
      "currency_type_id": "EUR",
      "amount_to_pay": "1000.51",
      "invoice_reference": "Test1",
      "country_id": 113,
      "request_reason_id": 7
  },
  "rates_data": {
      "currency_from": "USD",
      "currency_to": "EUR",
      "amount_from_before_fee": "1237.47",
      "fee_total_amount": "0.00",
      "amount_from_after_fee": "1237.47",
      "amount_to": "1000.51",
      "rate_per_unit": "0.80851",
      "count_back_sec": 91
  },
  "pay_details": {
      "transfer_type": "International Bank Transfer",
      "currency": "HRK",
      "amount": "HRK 7690.03",
      "particular": "",
      "account_name": "Interpay Limited",
      "bank_name": "BARCLAYS BANK PLC",
      "bank_country": "United Kingdom",
      "iban": "GB15BARC20850889177955",
      "account_number": "89177955",
      "sort_code": "208508",
      "swift_bic": "BARCGB22",
      "ref_number": "B1135619"
  }
}

Frequently Asked Questions

How do I make a payment to TransferMate?

Wire your funds to TransferMate’s nominated account on your booking confirmation using your unique reference.

How long will my transfer take?

Once TransferMate receive your payment, it will be processed immediately and will arrive with your Biller on the same day or next day.

How can I track my transfer?

The biller can track the transfer through the payment_request_list request.

Can I cancel my request?

Once a booking is authorized, the currency is immediately bought by TransferMate so if you cancel the transfer, the currency will be sold back and you would be liable for any cancellation fees.