MintEFT API Reference V1

Welcome to Mint Payments developer portal. You'll find here instructions and documentation to help you start the integration with our API.

MintEFT API fully supports REST.

To use a REST API, your application needs to make an HTTP request and process the response. The response format is JSON.

To integrate with Mint’s UAT system please use the following context root:

https://secure-uatsb.mintpayments.net/eft/v1/

For the production URL, please speak with customer support.

Security

Authentication

MintEFT uses an API keys to uniquely authenticate requests. Your API key will be issued by Mint during the on-boarding process. Your API keys are very important as using them will allow you to interact with MintEFT. Please make sure that you store the API keys with caution and never share them publicly to third parties.

API Keys should be provided in the request in the Authorization header as a bearer token.
e.g.

Authorization: Bearer xxxxxxxxxxxxx

Where xxxxxxxxxxxxx is the API Key.

Transaction Status

Many endpoints will return transaction status. Following a list with all transaction outcomes

Transaction Status

Status	Description
`PENDING`	the request has been submitted and is on queue for schedule
`AUTHORIZED`	Authorized by merchant's admin
`AUTHORISED_AND_LOCKED`	Transaction is scheduled and cannot be cancelled
`PENDING_BANK`	Pending Bank
`PENDING_SETTLEMENT`	Pending Settlement
`SETTLED`	the request has been settled / completed

TODO: Errors / Status Codes

In terms of error handling there will be 2 cases of errors

200 OK - Payment Successful - not an ERROR

After a call of an endpoint checking the HTTP response code will indicate if the transaction was OK or not.

In case of the 200 response, the status has to be checked to determine APPROVED from DECLINED.
All non 200 response codes indicate a failure.

#####`HTTP 200` Payment Successful That is not an error but just an example of the response you can expect if transaction was processed correctly

{  
    "transaction": {  
        "external_invoice_reference": "testinvoice",  
        "external_transaction_reference": "testpayment",  
         "passenger_name": "Nick",  
        "transaction_id": "276951089115830657",  
        "amount": 200.2,  
        "currency": "AUD",  
        "due_at_utc": "2021-07-12T14:24:42",  
        "created_date_utc": "2021-07-12T11:56:22.966",  
        "status": "pending_for_authorisation",  
        "type": "create_payment"  
    },  
    "payer": {  
        "mint_company_number": "M798240"  
    },  
    "payee": {  
        "mint_company_number": "M369164"  
    },  
    "response_code": "success",  
    "response_message": "Your request has been successfully processed."  
}

Non 200 Errors

All ‘non 200 errors’ will have the following JSON structure

    {
        "error_code": "invalid_payee",
        "error_message": "Could not find payee.",
        "request_uri": "/minteft/v1/transactions",
        "timestamp_utc": "2022-01-13T13:53:16.042"
    }

Based on the error_code and error_message in the table below ‘List of Mint Errors’ you would have to take action based on the case. So if the mandatory fields are missing passing all required values would solve the problem. If the date or amount is not in the expected format, checking the format of the passed values could correct the issue.

List of HTTP Errors

MintEFT uses standard HTTP response codes to indicate the success or failure of an API request. Codes in the HTTP 2xx range indicate success. Codes in the HTTP 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the HTTP 5xx range indicate an error with Mint's servers.

HTTP Status Codes

Status Code	Description
`200`	OK - The request was processed successfully
`400`	Bad request - The request contains missing parameters, is in an incorrect shape, or failed another validation test
`401`	Unauthorized - Please verify that the authentication token is provided and is valid
`403`	Forbidden, cases where customer do not have API enabled, service not enabled etc.
`404`	Not found - The requested endpoint does not exist
`405`	Method not allowed
`500`	Server error - Something went wrong on our end; please let us know if you are receiving this error.

List of Mint Errors

Error Code	Description
`processing_error`	Problems with processing of the transaction. Try re- run the transaction.
`processing_error`	An error occurred while processing your card. Try again later.
`processing_error`	Could not save mint card token or mint customer.
`processing_error`	No matches found for the reference Invoice Number is already taken.
`processing_error`	Failed to process your request. Please try again later.
`processing_error`	Invoice Number is already taken.
`mandatory_fields_missing`	Mandatory fields like amount details are missing
`mandatory_fields_missing`	Currency is missing or is invalid.
`mandatory_fields_missing`	The request has missing, null or empty attributes: [transaction.external_transaction_reference] [transaction.external_invoice_reference].
`mandatory_fields_missing`	The request has missing, null or empty attribute: [mint_company_number for Payer or Payee].
`mandatory_fields_missing_or_invalid`	Transaction Type is missing or is invalid.
`invalid_date_format`	Invalid date format, expected UTC date in yyyy-MM-dd'T'HH:mm:ss format
`invalid_payee`	Could not find payee.
`invalid_payer`	Could not find payer.

Versions

MintEFT, as all common APIs, uses versioning to guarantee seamless version upgrades and backward compatibility.

#####What is the current version?
The current version of MintEft is 1.0.

#Group RESTful API Reference

Payment [/transactions]

Resource /transactions

Posting a Payment [POST]

That is the endpoint to be called in order to process a payment. Method requires the payer and payee company number and the amount.

Parameters

Name	Type	Length		Description
`transaction.external_invoice_reference`	alphanumeric	128	mandatory	The external invoice number to be paid by the payer
`transaction.external_transaction_reference`	alphanumeric	128	mandatory	The external transaction number created by the payer
`transaction.passenger_name`	alphanumeric	128	optional	An optional parameter for passengers
`transaction.due_at_utc`	date	128	mandatory	The invoice due date
`transaction.amount`	number	32	mandatory	The amount of the invoice to be paid
`transaction.currency`	alphanumeric	128	mandatory	The currency of the invoice to be paid
`transaction.notes`	alphanumeric	128	mandatory	Optional notes to be attached during the payment
`transaction.type`	enum	enum	required	For posting an unauthorized payment (to be authorized later), use `create_payment`. For posting an authorized payment, use `create_and_authorise_payment`. To create an authorized payment that cannot be cancelled, use `create_and_lock_payment`.
`transaction.parent_transaction`	alphanumeric	128	optional	The parent transaction number that is to be referenced to any other subsequent transactions
`user.email`	alphanumeric		required	The email address of the user executing the transaction
`user.ip_address`	alphanumeric	128	required	The IP address of the user executing the transaction
`user.user_agent`	alphanumeric	128	required	The channel that the user uses to execute the transaction
`user.timezone`	number	19	optional	The timezone where the transaction initiated
`payer.mint_company_number`	number	2		The payer company number registered on the MintEFT platform
`payee.mint_company_number`	number	2		The payee company number registered in the MintEFT platform

Response

Name	Type	Description
`transaction.external_invoice_reference`	string	The external invoice number to be paid by the payer
`transaction.external_transaction_reference`	string	The external transaction number created by the payer
`transaction.passenger_name`	string	An optional parameter for passengers
`transaction.transaction_id`	string	The transaction number returned by the MintEFT platform
`transaction.amount`	number	The amount of the invoice to be paid
`transaction.currency`	string	The currency of the invoice to be paid
`transaction.due_at_utc`	date	The invoice due date
`transaction.created_date_utc`	date	The date when the transaction is posted
`transaction.status`	string	Status of the transaction
`transaction.type`	string	`CREATE_PAYMENT` or `CREATE_AND_AUTHORISE_PAYMENT` or `AUTHORISED_AND_LOCKED`
`payer.mint_company_number`	number	The payer company number registered on the MintEFT platform
`payee.mint_company_number`	number	The payee company number registered in the MintEFT platform
`response_code`	string	The status of the transaction
`response_message`	string	The description of the status

Request (application/json)

      {
          "transaction": {
              "external_invoice_reference": "testinvoice",
              "external_transaction_reference": "testpayment",
              "passenger_name": "Nick",
              "due_at_utc": "2022-01-06T14:24:42",
              "amount": "200.20",
              "currency": "AUD",
              "notes": "testing",
              "type": "create_payment",
              "parent_transaction": ""
          },
          "user": {
              "email": "[email protected]",
              "ip_address": "192.168.1.102",
              "user_agent": "test",
              "timezone": "Australia/Sydney"
          },
          "payer":{
              "mint_company_number": "M798240"
          },
          "payee":{
              "mint_company_number": "M369164"
          },
          "do_send_email_notification_after_authorization": true,
          "notification_recipients_emails": [
              "[email protected]",
              "[email protected]"
          ]
      }

Response 200 (application/json)

Body

  {
      "transaction": {
          "external_invoice_reference": "testinvoicetest1",
          "external_transaction_reference": "testpaymenttest1",
          "transaction_id": "98431831",
          "amount": 101.35,
          "currency": "AUD",
          "due_at_utc": "2021-07-12T14:24:42",
          "created_date_utc": "2021-08-03T06:34:19.190",
          "status": "pending_for_authorisation",
          "type": "create_payment"
      },
      "payer": {
          "mint_company_number": "testmerchant"
      },
      "payee": {
          "mint_company_number": "testsupplier"
      },
      "response_code": "success",
      "response_message": "Your request has been successfully processed."
  }

Requesting a Payment [POST]

That is the endpoint to be called in order to request a payment from the payee going to the payer. Method requires the payer and payee company number and the amount.

Parameters

Name	Type	Length		Description
`transaction.external_invoice_reference`	alphanumeric	128	mandatory	The external invoice number to be paid by the payer
`transaction.external_transaction_reference`	alphanumeric	128	mandatory	The external transaction number created by the payer
`transaction.passenger_name`	alphanumeric	128	optional	An optional parameter for passengers
`transaction.due_at_utc`	date	128	optional	The invoice due date
`transaction.amount`	number	32	mandatory	The amount of the invoice to be paid
`transaction.currency`	alphanumeric	128	mandatory	The currency of the invoice to be paid
`transaction.notes`	alphanumeric	128	mandatory	Optional notes to be attached during the payment
`transaction.type`	enum	enum	required	For posting a payment, this should use `request_payment`
`transaction.parent_transaction`	alphanumeric	128	optional	The parent transaction number that is to be referenced to any other subsequent transactions
`user.email`	alphanumeric		required	The email address of the user executing the transaction
`user.ip_address`	alphanumeric	128	required	The IP address of the user executing the transaction
`user.user_agent`	alphanumeric	128	required	The channel that the user uses to execute the transaction
`user.timezone`	number	19	optional	The timezone where the transaction initiated
`payer.mint_company_number`	number	2		The payer company number registered on the MintEFT platform
`payee.mint_company_number`	number	2		The payee company number registered in the MintEFT platform
`do_send_email_notification_after_authorization`	boolean	true/false		A flag to identify whether to receive the receipt via email
`notification_recipients_emails`	list	128		The email addresses of the receipt recipients

Response

Name	Type	Description
`transaction.external_invoice_reference`	string	The external invoice number to be paid by the payer
`transaction.external_transaction_reference`	string	The external transaction number created by the payer
`transaction.passenger_name`	string	An optional parameter for passengers
`transaction.transaction_id`	string	The transaction number returned by the MintEFT platform
`transaction.amount`	number	The amount of the invoice to be paid
`transaction.currency`	string	The currency of the invoice to be paid
`transaction.due_at_utc`	date	The invoice due date
`transaction.created_date_utc`	date	The date when the transaction is posted
`transaction.status`	string	The country that issued the credit card
`transaction.type`	string	Unique identifier per card. Tokenizing same card will generate different card token but will keep fingerprint same. NOTE: Unlike card token finger print can not be used for purchase.
`payer.mint_company_number`	number	The payer company number registered on the MintEFT platform
`payee.mint_company_number`	number	The payee company number registered in the MintEFT platform
`response_code`	string	The status of the transaction
`response_message`	string	The description of the status

Request (application/json)

      {
          "transaction": {
              "external_invoice_reference": "testinvoice",
              "external_transaction_reference": "testpayment",
              "passenger_name": "Nick",
              "due_at_utc": "2022-01-06T14:24:42",
              "amount": "200.20",
              "currency": "AUD",
              "notes": "testing",
              "type": "request_payment",
              "parent_transaction": ""
          },
          "user": {
              "email": "[email protected]",
              "ip_address": "192.168.1.102",
              "user_agent": "test",
              "timezone": "Australia/Sydney"
          },
          "payer":{
              "mint_company_number": "M798240"
          },
          "payee":{
              "mint_company_number": "M369164"
          },
          "do_send_email_notification_after_authorization": true,
          "notification_recipients_emails": [
              "[email protected]",
              "[email protected]"
          ]
      }

Response 200 (application/json)

Body

  {
      "transaction": {
          "external_invoice_reference": "testinvoicetest1",
          "external_transaction_reference": "testpaymenttest1",
          "transaction_id": "98431831",
          "amount": 101.35,
          "currency": "AUD",
          "due_at_utc": "2021-07-12T14:24:42",
          "created_date_utc": "2021-08-03T06:34:19.190",
          "status": "pending_for_authorisation",
          "type": "create_payment"
      },
      "payer": {
          "mint_company_number": "testmerchant"
      },
      "payee": {
          "mint_company_number": "testsupplier"
      },
      "response_code": "success",
      "response_message": "Your request has been successfully processed."
  }

Updating a transaction [POST]

That is the endpoint to be called in order to update an existing payment transaction, as long as it is not yet authorized. The request is similar to creating a payment, with an additional parameter transaction.transaction_id

Parameters

Name	Type	Length		Description
`transaction.transaction_id`	alphanumeric	128	mandatory	The existing transaction id to be updated. This is returned from a `create a payment request` call
`transaction.external_invoice_reference`	alphanumeric	128	mandatory	The external invoice number to be paid by the payer
`transaction.external_transaction_reference`	alphanumeric	128	mandatory	The external transaction number created by the payer
`transaction.passenger_name`	alphanumeric	128	optional	An optional parameter for passengers
`transaction.due_at_utc`	date	128	optional	The invoice due date
`transaction.amount`	number	32	mandatory	The amount of the invoice to be paid
`transaction.currency`	alphanumeric	128	mandatory	The currency of the invoice to be paid
`transaction.notes`	alphanumeric	128	mandatory	Optional notes to be attached during the payment
`transaction.type`	enum	enum	required	For posting a payment, use `create_payment`
`transaction.parent_transaction`	alphanumeric	128	optional	The parent transaction number that is to be referenced to any other subsequent transactions
`user.email`	alphanumeric		required	The email address of the user executing the transaction
`user.ip_address`	alphanumeric	128	required	The IP address of the user executing the transaction
`user.user_agent`	alphanumeric	128	required	The channel that the user uses to execute the transaction
`user.timezone`	number	19	optional	The timezone where the transaction initiated
`payer.mint_company_number`	number	2		The payer company number registered on the MintEFT platform
`payee.mint_company_number`	number	2		The payee company number registered in the MintEFT platform
`do_send_email_notification_after_authorization`	boolean	true/false		A flag to identify whether to receive the receipt via email
`notification_recipients_emails`	list	128		The email addresses of the receipt recipients

Response

Name	Type	Description
`transaction.external_invoice_reference`	string	The external invoice number to be paid by the payer
`transaction.external_transaction_reference`	string	The external transaction number created by the payer
`transaction.passenger_name`	string	An optional parameter for passengers
`transaction.transaction_id`	string	The transaction number returned by the MintEFT platform
`transaction.amount`	number	The amount of the invoice to be paid
`transaction.currency`	string	The currency of the invoice to be paid
`transaction.due_at_utc`	date	The invoice due date
`transaction.created_date_utc`	date	The date when the transaction is posted
`transaction.status`	string	Status of the transaction
`transaction.type`	string	`CREATE_PAYMENT`
`payer.mint_company_number`	number	The payer company number registered on the MintEFT platform
`payee.mint_company_number`	number	The payee company number registered in the MintEFT platform
`response_code`	string	The status of the transaction
`response_message`	string	The description of the status

Request (application/json)

      {
          "transaction": {
              "transaction_id": "98431831",
              "external_invoice_reference": "testinvoice",
              "external_transaction_reference": "testpayment",
              "passenger_name": "Nick",
              "due_at_utc": "2022-01-06T14:24:42",
              "amount": "200.20",
              "currency": "AUD",
              "notes": "testing",
              "type": "create_payment",
              "parent_transaction": ""
          },
          "user": {
              "email": "[email protected]",
              "ip_address": "192.168.1.102",
              "user_agent": "test",
              "timezone": "Australia/Sydney"
          },
          "payer":{
              "mint_company_number": "M798240"
          },
          "payee":{
              "mint_company_number": "M369164"
          },
          "do_send_email_notification_after_authorization": true,
          "notification_recipients_emails": [
              "[email protected]",
              "[email protected]"
          ]
      }

Response 200 (application/json)

Body

  {
      "transaction": {
          "external_invoice_reference": "testinvoicetest1",
          "external_transaction_reference": "testpaymenttest1",
          "transaction_id": "98431831",
          "amount": 101.35,
          "currency": "AUD",
          "due_at_utc": "2021-07-12T14:24:42",
          "created_date_utc": "2021-08-03T06:34:19.190",
          "status": "pending_for_authorisation",
          "type": "create_payment"
      },
      "payer": {
          "mint_company_number": "testmerchant"
      },
      "payee": {
          "mint_company_number": "testsupplier"
      },
      "response_code": "success",
      "response_message": "Your request has been successfully processed."
  }

Authorising a Payment [POST]

That is the endpoint to be called in order to authorise a transaction or a request made by either the agent or the payee. This can also be used to update payment details.
Method requires the payer and payee company number and the amount.

Parameters

Name	Type	Length		Description
`authorise_transaction_ids`	array	128	mandatory	A list of mint transaction numbers to authorise
`user.email`	alphanumeric		required	The email address of the user executing the transaction
`user.ip_address`	alphanumeric	128	required	The IP address of the user executing the transaction
`user.user_agent`	alphanumeric	128	required	The channel that the user uses to execute the transaction
`user.timezone`	number	19	optional	The timezone where the transaction initiated
`payer.mint_company_number`	number	2		The payer company number registered on the MintEFT platform

Response

Name	Type	Description
`transaction.external_invoice_reference`	string	The external invoice number to be paid by the payer
`transaction.external_transaction_reference`	string	The external transaction number created by the payer
`transaction.passenger_name`	string	An optional parameter for passengers
`transaction.transaction_id`	string	The transaction number returned by the MintEFT platform
`transaction.amount`	number	The amount of the invoice to be paid
`transaction.currency`	string	The currency of the invoice to be paid
`transaction.due_at_utc`	date	The invoice due date
`transaction.created_date_utc`	date	The date when the transaction is posted
`transaction.status`	string	Status of the transaction
`transaction.type`	string	`AUTHORISED_PAYMENT`
`payer.mint_company_number`	number	The payer company number registered on the MintEFT platform
`payee.mint_company_number`	number	The payee company number registered in the MintEFT platform
`response_code`	string	The status of the transaction
`response_message`	string	The description of the status

Request (application/json)

      {
          "authorise_transaction_ids": [
              "M00123456"
          ],
          "user": {
              "email": "[email protected]",
              "ip_address": "192.168.1.102",
              "user_agent": "test",
              "timezone": "Australia/Sydney"
          },
          "payer":{
              "mint_company_number": "M798240"
          }
      }

Response 200 (application/json)

Body

  {
      "transaction": {
          "external_invoice_reference": "testinvoicetest1",
          "external_transaction_reference": "testpaymenttest1",
          "transaction_id": "98431831",
          "amount": 101.35,
          "currency": "AUD",
          "due_at_utc": "2021-07-12T14:24:42",
          "created_date_utc": "2021-08-03T06:34:19.190",
          "status": "pending_for_authorisation",
          "type": "create_payment"
      },
      "payer": {
          "mint_company_number": "testmerchant"
      },
      "payee": {
          "mint_company_number": "testsupplier"
      },
      "response_code": "success",
      "response_message": "Your request has been successfully processed."
  }

Cancellation [/cancel/transactions]

Resource /cancel/transactions

Cancelling a Payment [POST]

That is the endpoint to be called in order to process a payment. Method requires the payer and payee company number and the amount.

Parameters

Name	Type	Length		Description
`transaction.transaction_id`	alphanumeric	128	mandatory	The transaction number returned by the MintEFT platform
`transaction.status`	alphanumeric	128	mandatory	Value should be `cancelled`

Response

Name	Type	Description
`response_code`	string	The status of the transaction
`response_message`	string	The description of the status
`transaction.transaction_id`	string	The transaction number returned by the MintEFT platform
`transaction.status`	string	Value should be `cancelled`

Request (application/json)

      {
          "transaction": {
              "transaction_id": "98431831",
              "status": "cancelled"
          },
          "user": {
              "email": "[email protected]"
          }
      }

Response 200 (application/json)
- Body
  
  {
  "transaction": {
  "transaction_id": "98431831",
  "status": "cancelled"
  },
  "response_code": "success",
  "response_message": "Your request has been successfully processed."
  }

Transaction Inquiry [/transaction-by-id/{transaction_id}]

Resource /transaction-by-id/[transaction-id]

Search a transaction by transaction id [GET]

That is the endpoint to be called in order to get the status of the transaction based on the transaction_id returned by MintEFT

Parameters

Name	Type	Length		Description
`transaction.transaction_id`	alphanumeric	128	mandatory	The transaction number returned by the MintEFT platform

Response

Name	Type	Description
`response_code`	string	The status of the transaction
`response_message`	string	The description of the status
`transaction.requested_by_email`	string	The email address of the requestor
`transaction.requested_by_name`	string	The name of the requestor
`transaction.from_company`	string	The source company name
`transaction.from_company_number`	string	The source company number
`transaction.to_company`	string	The destination company name
`transaction.to_company_number`	string	The destination company number
`transaction.passenger_name`	string	The optional passenger name
`transaction.amount`	string	The transaction amount
`transaction.currency`	string	The transaction currency
`transaction.type`	string	The transaction type
`transaction.created_at`	string	The date / time the transaction is created
`transaction.updated_at`	string	The date / time the transaction is updated
`transaction.authorized_at`	string	The date / time the transaction is authorized
`transaction.due_at`	string	The date / time the transaction is due
`transaction.invoice_number`	string	The third party invoice number
`transaction.transaction_reference`	string	The third party transaction reference number
`transaction.notes`	string	The transaction notes
`transaction.transaction_id`	string	The transaction number returned by the MintEFT platform
`transaction.status`	string	The status of the transaction

Request (application/json)

Response 200 (application/json)

Body

  {
  "transaction": {
          "requested_by_email": "[email protected]",
          "requested_by_name": "test",
          "from_company": "ABC Travel",
          "from_company_number": "M1234567",
          "to_company": "Wholesale Supplier",
          "to_company_number": "M987654",
          "transaction_id": "276951089115830657",
          "passenger_name": "Passenger",
          "amount": 200.20,
          "currency": "AUD",
          "type": "CREATE_PAYMENT",
          "created_at": "2021-07-12T11:56:22.967",
          "updated_at": "2021-09-01T14:06:04.450",
          "authorised_at": "2021-07-12T11:59:35.527",
          "due_at": "2021-07-12T14:24:42",
          "status": "PENDING_AT_BANK",
          "invoice_number": "testinvoice4",
          "transaction_reference": "testpayment4",
          "notes": "testing"
      },
      "response_code": "success",
      "response_message": "Your request has been successfully processed."
  }

Status History [/{transaction_id}/status-history]

Resource /[transaction_id]/status-history

Search a transaction history transaction id [GET]

That is the endpoint to be called in order to get the status of the transaction based on the transaction_id returned by MintEFT

Parameters

Name	Type	Length		Description
`transaction.transaction_id`	alphanumeric	128	mandatory	The transaction number returned by the MintEFT platform

Response

Name	Type	Description
`response_code`	string	The status of the transaction
`response_message`	string	The description of the status
`transaction.requested_by_email`	string	The email address of the requestor
`transaction.requested_by_name`	string	The name of the requestor
`transaction.from_company`	string	The source company name
`transaction.from_company_number`	string	The source company number
`transaction.to_company`	string	The destination company name
`transaction.to_company_number`	string	The destination company number
`transaction.passenger_name`	string	The optional passenger name
`transaction.amount`	string	The transaction amount
`transaction.currency`	string	The transaction currency
`transaction.type`	string	The transaction type
`transaction.created_at`	string	The date / time the transaction is created
`transaction.updated_at`	string	The date / time the transaction is updated
`transaction.authorized_at`	string	The date / time the transaction is authorized
`transaction.due_at`	string	The date / time the transaction is due
`transaction.invoice_number`	string	The third party invoice number
`transaction.transaction_reference`	string	The third party transaction reference number
`transaction.notes`	string	The transaction notes
`transaction.transaction_id`	string	The transaction number returned by the MintEFT platform
`transaction.status`	string	The status of the transaction
`status_history[].time_stamp`	string	The date and time the transaction status is updated
`status_history[].status`	string	The transaction status code

Request (application/json)

Response 200 (application/json)

Body

  {
      "transaction": {
          "requested_by_email": "[email protected]",
          "requested_by_name": "test",
          "from_company": "ABC Travel",
          "from_company_number": "M1234567",
          "to_company": "Wholesale Supplier",
          "to_company_number": "M987654",
          "transaction_id": "276951089115830657",
          "passenger_name": "Anh",
          "amount": 200.20,
          "currency": "AUD",
          "type": "CREATE_PAYMENT",
          "created_at": "2021-07-12T11:56:22.967",
          "updated_at": "2021-09-01T14:06:04.450",
          "authorised_at": "2021-07-12T11:59:35.527",
          "due_at": "2021-07-12T14:24:42",
          "status": "PENDING_AT_BANK",
          "invoice_number": "testinvoice4",
          "transaction_reference": "testpayment4",
          "notes": "testing"
      },
      "status_history": [
              {
                  "time_stamp": "2021-07-15T23:37:23.190",
                  "status": "PENDING_FOR_AUTHORISATION"
              },
              {
                  "time_stamp": "2021-07-20T08:08:06.927",
                  "status": "AUTHORISED"
              },
              {
                  "time_stamp": "2021-07-20T08:10:10.217",
                  "status": "PENDING_AT_BANK"
              },
              {
                  "time_stamp": "2021-07-20T08:13:51.557",
                  "status": "APPROVED"
              },
              {
                  "time_stamp": "2021-07-20T08:13:52.303",
                  "status": "PENDING_SETTLEMENT"
              },
              {
                  "time_stamp": "2021-07-20T08:15:18.173",
                  "status": "SETTLED"
              }
      ],
      "response_code": "00",
      "response_message": "Successful"
  }

Search Transactions [/transaction_search]

Resource /transaction_search

Search a transaction [GET]

That is the endpoint to be called in order to query all transactions based on the given filter.

Parameters

Name	Type	Length		Description
`payer_number`	alphanumeric	128	mandatory	The payer mint company number
`payee_number`	alphanumeric	128	mandatory	The payee mint company number
`requested_user`	alphanumeric	128	optional	The user who initiated the transaction
`passenger_name`	alphanumeric	128	optional	An optional parameter for passengers
`status`	alphanumeric	128	optional	The status of the transaction
`start_time`	date_time_utc	128	optional	The transaction start time in UTC
`end_time`	date_time_utc	128	optional	The time transaction is finished in UTC
`min_amount`	number	128	optional	Minimum amount
`max_amount`	number	128	optional	Maximum amount
`invoice_number`	alphanumeric	128	optional	The 3rd party invoice number
`transaction_reference`	alphanumeric	128	optional	The 3rd party transaction reference number
`page`	number	128	optional	The page number of the queried result
`size`	number	128	optional	The size per page
`transaction_id`	alphanumeric	128	optional	The transaction ID returned by MintEFT
`reseller_code`	alphanumeric	128	optional	The parent reseller code
`transaction_type`	alphanumeric	128	optional	The type of transaction made

Response

Name	Type	Description
`response_code`	string	The status of the transaction
`response_message`	string	The description of the status
`transaction.transaction_id`	string	The transaction number returned by the MintEFT platform
`transaction.status`	string	Value should be `cancelled`

Request (application/json)

Response 200 (application/json)

Body

  {
          "transactions": [
          {
              "requested_by_email": "[email protected]",
              "requested_by_name": "admin test",
              "from_company": "ABC Travel",
              "from_company_number": "M1234567",
              "to_company": "Wholesale Supplier",
              "to_company_number": "M987654",
              "transaction_id": "114203184959212113",
              "passenger_name": "Anh",
              "amount": 15.00,
              "currency": "AUD",
              "type": "CREATE_PAYMENT",
              "created_at": "2021-07-27T00:01:52.170",
              "updated_at": "2021-07-27T14:05:52.907",
              "authorised_at": "2021-07-27T00:06:15.370",
              "due_at": "2021-07-28T00:00",
              "status": "SETTLED",
              "invoice_number": "1234hmnew",
              "transaction_reference": "newhm",
              "notes": "testing",
              "parent_transaction": null
          },
          {
          "requested_by_email": "[email protected]",
          "requested_by_name": "admin test",
          "from_company": "ABC Travel",
          "from_company_number": "M1234567",
          "to_company": "Wholesale Supplier",
          "to_company_number": "M987654",
          "transaction_id": "755428605918848257",
          "passenger_name": "Anh",
          "amount": 0.25,
          "currency": "AUD",
          "type": "CREATE_PAYMENT",
          "created_at": "2021-07-27T06:44:51.263",
          "updated_at": "2021-07-27T06:51:59.640",
          "authorised_at": "2021-07-27T06:48:04.990",
          "due_at": "2021-07-27T00:00",
          "status": "SETTLED",
          "invoice_number": "HW-270721",
          "transaction_reference": "HW-270721",
          "notes": "testing",
          "parent_transaction": null
          }
          ],
          "pagination": {
              "total_count": 29,
              "start_index": 0,
              "end_index": 2
          }
  }

Search Payee [/payee-search]

Resource /payee-search

Search a payee [GET]

That is the endpoint to be called in order to query all transactions based on the given filter.

Parameters

Name	Type	Length		Description
`company_number`	alphanumeric	128	mandatory	The payer mint company number
`payee_name_or_number`	alphanumeric	128	optional	The payee mint company number or name
`is_search_all`	boolean	true/false	optional	If all payees are to be listed
`is_payer_search`	boolean	true/false	optional	If set to false for a Merchant Company, it includes PAYEE_ONLY along with SUPPLIERS. Else, includes MERCHANT
`page`	number	128	optional	The page number of the queried result
`size`	number	128	optional	The size per page

Response

Name	Type	Description
`response_code`	string	The status of the transaction
`response_message`	string	The description of the status
`payees`	string	List of payees

Request (application/json)

Response 200 (application/json)

Body

  {
    "payees": [
      {
        "company_number": "M834372",
        "name": "asgjagjagj",
        "trading_name": "Larkin, Leuschke and Maggio",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M788825",
        "name": "nzphonenot002",
        "trading_name": "nzphonenot002",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M633535",
        "name": "testaucompaniesforbank",
        "trading_name": "testaucompaniesforbank",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M871326",
        "name": "newtesthm1234",
        "trading_name": "newtesthm1234",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M235589",
        "name": "test1256789",
        "trading_name": "test1256789",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M241882",
        "name": "test1234567",
        "trading_name": "test1234567",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M490711",
        "name": "test NZ Mint12",
        "trading_name": "testhm1234",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M391318",
        "name": "test1293987",
        "trading_name": "test1293987",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "ACTIVATED",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M479231",
        "name": "after smtp changes",
        "trading_name": "after smtp changes",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M723031",
        "name": "testhmddchanges",
        "trading_name": "tradingtesthm",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "ACTIVATED",
        "payout_channel": "direct_entry"
      }
    ],
    "pagination": {
      "total_count": 197,
      "start_index": 0,
      "end_index": 9
    },
    "response_code": "00",
    "response_message": "Successful"
  }

Body

  {
    "payees": [
      {
        "company_number": "M834372",
        "name": "asgjagjagj",
        "trading_name": "Larkin, Leuschke and Maggio",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M788825",
        "name": "nzphonenot002",
        "trading_name": "nzphonenot002",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M633535",
        "name": "testaucompaniesforbank",
        "trading_name": "testaucompaniesforbank",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M871326",
        "name": "newtesthm1234",
        "trading_name": "newtesthm1234",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M235589",
        "name": "test1256789",
        "trading_name": "test1256789",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M241882",
        "name": "test1234567",
        "trading_name": "test1234567",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M490711",
        "name": "test NZ Mint12",
        "trading_name": "testhm1234",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M391318",
        "name": "test1293987",
        "trading_name": "test1293987",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "ACTIVATED",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M479231",
        "name": "after smtp changes",
        "trading_name": "after smtp changes",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "NEW",
        "payout_channel": "direct_entry"
      },
      {
        "company_number": "M723031",
        "name": "testhmddchanges",
        "trading_name": "tradingtesthm",
        "email": "[email protected]",
        "phone": "123456789",
        "country": "AU",
        "status": "ACTIVATED",
        "payout_channel": "direct_entry"
      }
    ],
    "pagination": {
      "total_count": 197,
      "start_index": 0,
      "end_index": 9
    },
    "response_code": "00",
    "response_message": "Successful"
  }