Recur Capture API Call
The SurchX recur-capture API is called when the merchant wants to register a payment capture
which is exactly the same as a previously calculated Transaction Fee (surcharge). This endpoint
is specifically provided for merchants who split a transaction across installment payments. When
the next installment payment has been processed, a call to this endpoint will register this transaction.
Note: Because this workflow requires the base surcharge attributes (NICN, region, and amount) to be
exactly the same as the original, it is acceptable to pass in as much information as available in the context.
If the contextual information includes any NICN, region, or amount data that is different than
the original, it will fail. That failure can most likely be expected and ignored by the merchant in this case.
https://api-test.surchx.com/v1/recur/capture
For testing purpose, please use the Test Cards
Content-Type : application/json
X-Requested-With : xhr
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1NzE3Mjc2MDAsImlhdCI6MTU2NjUwMDMxOCwibmFtZSI6IkhVR08gRE9DUyAtKERPTlQgREVMRVRFKSIsImlkIjoiNjVlZmJiMjMtNGY4Zi00M2ZjLTk1MDQtODk4YThjZWQzNWNkIn0.ehlu051arjjraE8E5PP8WBM_YBfS2r4CPoS_V_D8hog
{
"sTxId": "5tjih88nsy1fzkvj0e54kuyv4",
"country":"840",
"region":"85004",
"processor":"standard",
"nicn":"424242",
"amount":100,
"authCode": "auth-0001"
}
{
"sTxId": "y7qz8piitbmd1ilnunxgupds"
}
| Name | Information | Mandatory |
|---|---|---|
| mTxId | Merchant orderId or unique identifier in the Merchant e-commerce scope referencing the Order or Shopping Cart. This field is optional. | Yes, if sTxId is not passed |
| sTxId | Unique identifier in the SurchX system which refers to the persistence state of the Transaction Fee calculation. | Yes, if mTxId is not passed |
| authCode | Processing authorization code. Used for reconciliation. | No; but preferred |
| nicn | Read-only NICN used when processing | No; takes the previous Transaction Fee NICN value |
| region | Read-only Region of transaction | No; takes the previous Transaction Fee Region value |
| amount | Read-only Amount of transaction | No; takes the previous Transaction Fee Amount value |