Transactions API

The Transactions API provides access to transaction data that has been successfully processed by the Money API™.

Authentication

The Transactions API utilizes SSL encryption to secure the data while in transit and authenticates the partner via their API key that is transmitted in the header. The partner will place the API key within the header parameter “X-API-KEY”.

URL

The url to access the Transactions API is https://customer.api.securenet.live

Requests

GET requests will expect their parameters within the url/querystring.

Responses

The API will respond with JSON encoded data.

Methods

The following section gives the methods available within this API.

/ping/ (GET)

The GET /ping/ method is used to confirm basic integration is working, the response of the ping method will return the current time. The time will be in UTC.

Example Response

{
    "success": "true",
    "time": 1617028757.5924342
}

/transaction/{id} (GET)

The GET /transaction method will return a specific transaction, based upon the id provided.

The following are query parameters that may be applied to the transaction request in standard query string fashion:

Parameter	Description
ext_transaction_ref_id	string, provided as the ID of the transaction via integration.
merchant_id	A string representing the merchant_id supplied at the start of the transaction.
consumer_id	string, representing the consumer_id supplied at the start of the transaction.
fi_id	string, representing the particular abbreviation code for a given financial institution.
between_start_date_created	string, will find records after this datetime, “YYYY-MM-DD HH:MM:SS” format.
between_end_date_created	string, will find records before this datetime, “YYYY-MM-DD HH:MM:SS” format.
records_per_page	integer, representing # records to return, allowing for pagination. Max 10K.
page_number	integer, representing the page of records to be returned.
order_by_field	string, the specific field the records will be sorted by.
order_by_dir	string, the order in which the records will be sorted. ASC, DESC

Example Response

{
    "success":"true",
    "paging":{
       "total_records":1,
       "records_per_page":1,
       "page_number":1
    },
    "transaction":[
       {
          "transaction_id":"gq99rv41tm91qw44bs**************",
          "transaction_type_id":1,
          "transaction_type_label":"CAPTURE",
          "client_id":"ddc59352554e6a5334e9cb476857cb73919******************",
          "merchant_id":"0001",
          "consumer_id":"0001",
          "fi_id":"boa",
          "amount":2.37,
          "currency":"USD",
          "ext_transaction_ref_id":"0001",
          "ext_data":"YXR0ZW1wdCAzIHdpdGggZGFsdG9uIGFjY291bnQ=",
          "payment_memo":null,
          "payment_ref_id":"ounm0*****",
          "payment_error_code":null,
          "payee_token":"****@****.com",
          "payee_label":"AppBrilliance company",
          "status_code_id":1,
          "status_code_label":"SUCCESS",
          "consumer_ip":"111.11.111.11",
          "consumer_agent_id":6,
          "consumer_agent_label":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.128 Safari/537.36",
          "ref_transaction_id":null,
          "date_created":"2021-04-20T22:41:54"
       }
    ]
}