a a

Transaction Status Management

Using sTxId and mTxId to manage the InterPayments transaction status

The sTxId is a unique system transaction ID that InterPayments generates for each new transaction (not each call to the API).
An InterPayments transaction can be updated or change status by using the sTxId to reference the transaction.

Transaction status management using sTxId:
You do not include a sTxId on a new transaction call
Example:
Customer initiates a $10.00 purchase and enters card number 3792671111111111 and zip code 90210.
Send /ch
{
“nicn”: “379267”,
“region”: “90210”,
“amount”: 10.00
}

Get back
{
“transactionFee”: 0.4,
“sTxId”: “5eda8f9e5f00002800554f4f”,
“message”: “ok”
}
We assigned the id 5eda8f9e5f00002800554f4f to this transaction. This InterPayments generated unique ID is called the sTxId.
You can use this sTxId to update or complete this transaction.
If the customer were to make changes to the input data before completing the purchase then you call the transaction fee service again and include the sTxId with the call and InterPayments will know to update the transaction instead of creating a new one:
Send /ch
{
“nicn”: “379267”,
“region”: “90210”,
“amount”: 20.00,
“sTxId”: “5eda8f9e5f00002800554f4f”,
}

Get back
{
“transactionFee”: 0.8,
“sTxId”: “5eda8f9e5f00002800554f4f”,
“message”: “ok”
}
You may update a transaction as many times as needed.

When the customer completes the transaction (clicks buy) then you send a sale call with that same sTxId and InterPayments will update the status of the InterPayments transaction to completed.
Send /ch/sale
{
“sTxId”: “5eda8f9e5f00002800554f4f”
}

Get back
{
“sTxId”: “5eda8f9e5f00002800554f4f”
}
This confirms the InterPayments transaction status was updated to complete.

Transaction status management using mTxId:
Alternatively, if your system has already assigned a unique identifier to the transaction you may choose to use it to track and update the transaction.
We call a merchant assigned unique transaction ID a mTxId.
When calling the transaction fee calculator you may include a mTxId then we will assign that value to the InterPayments transaction and allow you to use that value to reference the transaction for updates and completion.
Example:
Customer initiates sales process and merchant assigns the unique identifier to the transaction of “merchant-po-1234”.
Send /ch
{
“nicn”: “379267”,
“region”: “90210”,
“amount”: 10.00,
“mTxId”:“merchant-po-1234”
}

Get back
{
“transactionFee”: 0.4,
“sTxId”: “5eda939c5f0000b602554f50”,
“message”: “ok”
}
We assigned the id 5eda939c5f0000b602554f50 to this transaction. This InterPayments generated unique ID is called the sTxId.
Now you can use either mTxId or sTxId to reference this transaction going forward.
If the customer were to make changes to the input data before completing the purchase then you call the transaction fee service again and include the mTxId with the call and InterPayments will know to update the transaction instead of creating a new one:
Send /ch
{
“nicn”: “379267”,
“region”: “90210”,
“amount”: 20.00,
“mTxId”:“merchant-po-1234”
}

Get back
{
“transactionFee”: 0.8,
“sTxId”: “5eda939c5f0000b602554f50”,
“message”: “ok”
}
You may update a transaction as many times as needed.

When the customer completes the transaction (clicks buy) then you send a sale call with that same mTxId and InterPayments will update the status of the InterPayments transaction to completed.
Send /ch/sale
{
“mTxId”:“merchant-po-1234”
}

Get back
{
“sTxId”: “5eda939c5f0000b602554f50”
}
This confirms the InterPayments transaction status was updated to complete.

A few additional notes about ID’s
>> - sTxId is never assigned by the merchant, it is always created by InterPayments.
>> - You can include both sTxId and mTxId in an update call or a sales call but the sTxId must match a previous value.
>> - You can add a mTxId to a existing transaction by including the mTxId value with the sTxId in a update call or by including it in the sale call along with the sTxId.