Welcome to Authz1 Knowledge Base
Transaction Commit Endpoint Request and Response
Requset
A Post request to the Transaction Commit Endpoint looks like:
http://[host]:8080/v1/transactions
Request body:
{
"subjectId": "U000001",
"actionId": "3",
"resourceId": "A000000003",
"trxDateTime": "2022-11-15T00:00:01-04:00",
"trxId": "T0755377",
"trxAmount": 80,
"unit": "cad",
"passLimits": ["L000000022","L000000036","L000000037","L000000020"]
}
Response:
The response to the request above is:
{
"userId": "U000001",
"transactionId": "T0755377",
"transactionAmount": 80.0,
"unit": "cad",
"actionId": "3",
"passLimits": [
"L000000022",
"L000000036",
"L000000037",
"L000000020"
],
"result": true,
"limits": [
{
"id": "L000000001",
"name": "TL1",
"type": "transactional",
"amount": 300.0,
"remainingAmount": 220.0,
"timePeriod": null,
"actionId": "3",
"resourceId": null,
"level": "Group",
"subjectId": "G000003",
"subjectName": "Group A3",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000027",
"name": "AL5",
"type": "aggregate_non_rolling",
"amount": 20000.0,
"remainingAmount": 19263.3701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000004",
"subjectName": "Role A4",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000023",
"name": "AL1",
"type": "aggregate_rolling",
"amount": 10000.0,
"remainingAmount": 9251.7101,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000001",
"subjectName": "Role A1",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000026",
"name": "AL4",
"type": "aggregate_non_rolling",
"amount": 18000.0,
"remainingAmount": 17668.9701,
"timePeriod": "w",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000006",
"subjectName": "Role A6",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000025",
"name": "AL3",
"type": "aggregate_non_rolling",
"amount": 15000.0,
"remainingAmount": 14668.9701,
"timePeriod": "d",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000005",
"subjectName": "Role A5",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000024",
"name": "AL2",
"type": "aggregate_rolling",
"amount": 12000.0,
"remainingAmount": 11458.8701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Group",
"subjectId": "G000001",
"subjectName": "Group A1",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000028",
"name": "AL6",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 9458.0701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000003",
"subjectName": "Role A3",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000029",
"name": "AL7",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 9458.9701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000013",
"subjectName": "Role A13",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000030",
"name": "AL8",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 9458.9701,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000012",
"subjectName": "Role A12",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000032",
"name": "AL10",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 9250.6101,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Global",
"subjectId": "U000001",
"subjectName": null,
"withinLimit": true,
"definedBy": "enterprise",
"effective": true
},
{
"id": "L000000016",
"name": "IL4",
"type": "individual_rolling",
"amount": 1000.0,
"remainingAmount": 804.37,
"timePeriod": "d",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000002",
"subjectName": "Role A2",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000013",
"name": "IL1",
"type": "individual_rolling",
"amount": 4000.0,
"remainingAmount": 3594.37,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000001",
"subjectName": "Role A1",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000046",
"name": "IL15",
"type": "individual_non_rolling",
"amount": 1500.0,
"remainingAmount": 1304.37,
"timePeriod": "d",
"actionId": "3",
"resourceId": null,
"level": "Customer_CD",
"subjectId": "U000001",
"subjectName": null,
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000017",
"name": "IL5",
"type": "individual_non_rolling",
"amount": 2000.0,
"remainingAmount": 1804.37,
"timePeriod": "w",
"actionId": "3",
"resourceId": null,
"level": "Role",
"subjectId": "R000006",
"subjectName": "Role A6",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000045",
"name": "IL14",
"type": "individual_non_rolling",
"amount": 5000.0,
"remainingAmount": 4594.37,
"timePeriod": "m",
"actionId": "3",
"resourceId": null,
"level": "Customer_CD",
"subjectId": "U000001",
"subjectName": null,
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000034",
"name": "TL14",
"type": "transactional",
"amount": 500.0,
"remainingAmount": 420.0,
"timePeriod": null,
"actionId": "3",
"resourceId": "A000000003",
"level": "Role",
"subjectId": "R000004",
"subjectName": "Role A4",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000040",
"name": "AL12",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 2128.31,
"timePeriod": "w",
"actionId": "3",
"resourceId": "A000000003",
"level": "Role",
"subjectId": "R000004",
"subjectName": "Role A4",
"withinLimit": true,
"definedBy": "customer",
"effective": true
},
{
"id": "L000000039",
"name": "AL11",
"type": "aggregate_non_rolling",
"amount": 10000.0,
"remainingAmount": 2096.03,
"timePeriod": "m",
"actionId": "3",
"resourceId": "A000000003",
"level": "Role",
"subjectId": "R000001",
"subjectName": "Role A1",
"withinLimit": true,
"definedBy": "customer",
"effective": true
}
]
}For the description of the request and response elements, please see Authz1 Transactions API OpenAPI Spec (YAML).
To learn about the Transaction Commit Endpoint from a business perspective, see the Transaction Commit Endpoint business documentations.