> For the complete documentation index, see [llms.txt](https://docs.sensepass.com/sensepay/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sensepass.com/sensepay/transaction-api/sdk-and-iframes/javascript-ui-sdk/commit-transaction.md).
# Commit Transaction
Backend verification step to complete the payment
{% hint style="danger" %}
This API call must be performed from your backend and not through the JS in the frontend.
{% endhint %}
## Backend verification step to complete the payment
`POST` `https://api.sensepass.com/api/transactions/:transactionNumber/commit`
**Authentication options:**
Device ID / Merchant API Key + Branch Number / Branch API key
#### Path Parameters
| Name | Type | Description |
| --------------------------------------------------- | ------ | ------------------------------------------- |
| transactionNumber\* | String | transaction number of the ready-transaction |
{% hint style="info" %}
"pay" callback from the SDK contains the transaction number for this API call
{% endhint %}
#### Request Body
| Name | Type | Description | | | |
| -------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- | --- | --- | ------------------------------------------------------------- |
| deviceId | String | location's device id - required if no api key | | | |
| methodType\* | Enum | manual\_capture or tokenize or authorize | | | |
| apiKey | String | merchant/location api key | | | |
| branchNumber | String | required if merchant api key is used.
e.g. 123
| | | |
| callbackURL | String | URL (POST/GET) to receive transaction changes | | | |
| metadata | Array | [Metadata Model](/sensepay/transaction-api/models/metadata-model.md) | | | |
| currency | String | Defaults to location's locale.
USD | CAD | EUR | ILS (etc)
Required for manual\_capture transactions
|
| amount | | Amount in cents.
Required for manual\_capture or authorize transactions
| | | |
| products | Array | [Product Model](/sensepay/transaction-api/models/product-model.md) | | | |
| receipt | Object | [Receipt Model](/sensepay/transaction-api/models/receipts-model.md) | | | |
| posData | Object | Any object/array you'd like to receive using the callback URL | | | |
{% tabs %}
{% tab title="200: OK " %}
{% code overflow="wrap" lineNumbers="true" %}
```json
{
"success": true,
"transactionNumber": "a4e22734c3f0bae26d8b6e422f71a221f3c7b55c8619e4f338c689f9",
"transactionStatus": "TransactionApproved",
"paymentDetails": {
"type": "Tokenize",
"paymentMethod": "Credit Card",
"created": "2023-08-21T13:21:06.407Z",
"token": "nraag50tyb3i7woz4vt76x4drt72ejs9yjgm7ia3xoc8nx3ywpxxtrzk0dgvkw41ozkqhqi6ozlidmj7i37c4th3db08423fz1evpzpcheoplmvbugen5xf9vxn9i2phlk9hviq3me5a4rko0jykcpj7dzj3337uxzrovff8w3orwrag6kq0luyqgpadts53tazllt70guj1kiuibmgh8mw3m0jeunq7bxjf9cdtnksdgat5gfgwm9umgvjb9ddqp"
},
"confirmation": {
"approvedBy": "Cardknox Sandbox",
"dateApproval": "2023-08-21T13:21:06.434Z",
"approvalDate": "2023-08-21T13:21:06.434Z",
"paymentType": "Regular",
"sensePassReferenceId": "av7e3z4rgqa9jhaqjlqs",
"paymentMethodCode": 25,
"paymentMethodName": "Credit Card",
"paymentMethodLogo": "https://pay.sandbox.sensepass.com/publicAssets/payment-method/cardknox.png",
"sourceProvider": {
"name": "Credit Card",
"code": 1
},
"providerId": "6wMjGG7cJ5KPTvzLOXKTIJjwdREImIsJGNpmGckfBiU=",
"authNumber": "fh7s94jf8s",
"acquirer": "hfs7048f4",
"voucher": "hf7s08opdg",
"referenceNumber": "ajsh795giyd",
"amount": 0,
"confirmationNumber": "174-30243A",
"fullConfirmationCode": "174-30243A",
"providerName": "Cardknox Sandbox",
"cardType": "VISA",
"lastFourDigits": "1111",
"cardMask": "411111******1111",
"expiration": "1234",
"cardExpiration": "1234",
"installments": 1,
"paymentMethod": "Credit Card",
"Credit Card": {
"cardType": "VISA",
"lastFourDigits": "1111",
"mask": "411111******1111",
"expiration": "1234"
},
"extraDetails": {
"email": "john@doe.org"
}
}
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
### Example - Manual Capture Response
```json
{
"success": true,
"transactionNumber": "a4e22734c3f0bae26d8b6e422f71a221f3c7b55c8619e4f338c689f9",
"transactionStatus": "TransactionApproved",
"paymentDetails": {
"type": "Manual_Capture"
},
"confirmation": {
"approvedBy": "Cardknox Sandbox",
"dateApproval": "2023-08-21T13:21:06.434Z",
"approvalDate": "2023-08-21T13:21:06.434Z",
"paymentType": "Regular",
"sensePassReferenceId": "av7e3z4rgqa9jhaqjlqs",
"paymentMethodCode": 25,
"paymentMethodName": "Credit Card",
"paymentMethodLogo": "https://pay.sandbox.sensepass.com/publicAssets/payment-method/cardknox.png",
"sourceProvider": {
"name": "Credit Card",
"code": 1
},
"providerId": "6wMjGG7cJ5KPTvzLOXKTIJjwdREImIsJGNpmGckfBiU=",
"authNumber": "fh7s94jf8s",
"acquirer": "hfs7048f4",
"voucher": "hf7s08opdg",
"referenceNumber": "ajsh795giyd",
"amount": 0,
"confirmationNumber": "174-30243A",
"fullConfirmationCode": "174-30243A",
"providerName": "Cardknox Sandbox",
"cardType": "VISA",
"lastFourDigits": "1111",
"cardMask": "411111******1111",
"expiration": "1234",
"cardExpiration": "1234",
"installments": 1,
"paymentMethod": "Credit Card",
"Credit Card": {
"cardType": "VISA",
"lastFourDigits": "1111",
"mask": "411111******1111",
"expiration": "1234"
},
"extraDetails": {
"email": "john@doe.org"
}
}
}
```
### Example - Tokenize Response
```json
{
"success": true,
"transactionNumber": "a4e22734c3f0bae26d8b6e422f71a221f3c7b55c8619e4f338c689f9",
"transactionStatus": "TransactionApproved",
"paymentDetails": {
"type": "Tokenize",
"paymentMethod": "Credit Card",
"created": "2023-08-21T13:21:06.407Z",
"token": "nraag50tyb3i7woz4vt76x4drt72ejs9yjgm7ia3xoc8nx3ywpxxtrzk0dgvkw41ozkqhqi6ozlidmj7i37c4th3db08423fz1evpzpcheoplmvbugen5xf9vxn9i2phlk9hviq3me5a4rko0jykcpj7dzj3337uxzrovff8w3orwrag6kq0luyqgpadts53tazllt70guj1kiuibmgh8mw3m0jeunq7bxjf9cdtnksdgat5gfgwm9umgvjb9ddqp"
},
"confirmation": {
"approvedBy": "Cardknox Sandbox",
"dateApproval": "2023-08-21T13:21:06.434Z",
"approvalDate": "2023-08-21T13:21:06.434Z",
"paymentType": "Regular",
"sensePassReferenceId": "av7e3z4rgqa9jhaqjlqs",
"paymentMethodCode": 25,
"paymentMethodName": "Credit Card",
"paymentMethodLogo": "https://pay.sandbox.sensepass.com/publicAssets/payment-method/cardknox.png",
"sourceProvider": {
"name": "Credit Card",
"code": 1
},
"providerId": "6wMjGG7cJ5KPTvzLOXKTIJjwdREImIsJGNpmGckfBiU=",
"authNumber": "fh7s94jf8s",
"acquirer": "hfs7048f4",
"voucher": "hf7s08opdg",
"referenceNumber": "ajsh795giyd",
"amount": 0,
"confirmationNumber": "174-30243A",
"fullConfirmationCode": "174-30243A",
"providerName": "Cardknox Sandbox",
"cardType": "VISA",
"lastFourDigits": "1111",
"cardMask": "411111******1111",
"expiration": "1234",
"cardExpiration": "1234",
"installments": 1,
"paymentMethod": "Credit Card",
"Credit Card": {
"cardType": "VISA",
"lastFourDigits": "1111",
"mask": "411111******1111",
"expiration": "1234"
},
"extraDetails": {
"email": "john@doe.org"
}
}
}
```
### Example - Authorization Response
```json
{
"success": true,
"transactionNumber": "cb3934c8e1be2f1c0bd171105e1b5a4e69a133dd2788d8cf02320142",
"transactionStatus": "TransactionApproved",
"paymentDetails": {
"type": "Authorize",
"created": "2024-01-03T11:01:10.403Z",
"token": "o7nmy73bofjrioyuinvdu49qjm00xgb98c7j7d5fpcqm6t9lb7zc6pzpeckp7oron4e336ee4ad9hr650ktz2qt1glbfaf8mp2mvc79negly0rvlpx3pyi7a7696lac3bc29ytb7g6af8a8os1cbvgxf18xk8ozh0lyn7p0myqvurn786jxyf8f0vjhdsgx2840t4esry5nfaf6c93jgaj73iqmpypzsvdolyd0s7v0hh2u4j08u8pmol83xr7y1",
"authNumber": null,
"acquirer": null,
"voucher": null,
"referenceNumber": null,
"requestID": "10126600836",
"approvedBy": "Cardknox Sandbox"
}
}
```
### Example - Decline
```json
{
"success": false,
"transactionNumber": "02b80210dce0b648384e512554a1688b66734c25100b0d3914d93375",
"transactionStatus": "TransactionDeclined",
"error": "Invalid Card"
}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.sensepass.com/sensepay/transaction-api/sdk-and-iframes/javascript-ui-sdk/commit-transaction.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.