Adjustment

The Adjustments Service supports creating, searching and deleting adjustments. Adjustments are tied to a transaction and represent changes to the transaction, such as a bank or merchant-initiated return. Adjustments have their own lifecycle outside the transaction being adjusted. For example, adjustments are marked for inclusion in automations via the Build AR Model step and have their own commit date based on that process. In general, the original transaction's status is changed to Returned when an adjustment is created on that transaction.

Create a new Adjustment on a Transaction

Creates an adjustment on a transaction, if allowed.

SecurityJWT
Request
Request Body schema:
object (BusinessUnit)

Business unit to which this user is authorized (and all business units below)

busUnitId
required
integer <int32>

System Id of the Business Unit owning the adjustment (and the transaction)

transactionId
integer <int64>

Id of the transaction being adjusted

importDate
string <date-time>

Date the transaction was imported into the system

traceNumber
string

Trace number of the transaction being adjusted

amount
number

Amount of the adjustment. In some cases, this must match the transaction's amount.

userId
integer <int32>

Id of the user that made the adjustment.

createDate
string <date-time>

Date the adjustment was created.

reasonCode
integer <int16>

Reason code/reject code for the adjustment.

reasonDesc
string

Reason description for the adjustment.

comment
string

User comment for the adjustment.

commitDate
string <date-time>

Date the adjustment was extracted.

systemId
integer <int64>

System Id for this object

partitionNumber
integer <int32>

Database partition number where transaction is stored.

status
string

Current status of the object

opmtPaymentType
string

Payment type of the transcation (CARD/ACH/CHECK..)

object (RejectCode)

Reject code for the transaction if any

object (RejectCode)

Reject code for the transaction if any

Array of objects (FieldValue)

Custom fields of the object

Array of objects (AuditEntry)

Audit Entries of the object

Array of objects (ValViolation)

Validation Violations of the object

Responses
200

Success

400

Bad Request, Invalid Parameters

403

Forbidden

404

Not Found

500

Internal Server Error

post/cw/adjustments/adjustment
Request samples
{
  • "busUnit": {
    },
  • "busUnitId": 23143,
  • "transactionId": 123434,
  • "importDate": "2023/07/08 13:04:48.145X",
  • "traceNumber": "1234132",
  • "amount": 1234132,
  • "userId": 1234,
  • "createDate": "2023/07/08 13:04:48.145X",
  • "reasonCode": 14,
  • "reasonDesc": "ACCOUNT CLOSED",
  • "comment": "Customer requested return",
  • "commitDate": "2023/07/08 13:04:48.145X",
  • "systemId": 12341,
  • "partitionNumber": 34,
  • "status": "Accepted",
  • "opmtPaymentType": "string",
  • "softRejectCode": {
    },
  • "hardRejectCode": {
    },
  • "customFields": [
    ],
  • "auditEntries": [
    ],
  • "violations": [
    ]
}
Response samples
{
  • "busUnit": {
    },
  • "busUnitId": 23143,
  • "transactionId": 123434,
  • "importDate": "2023/07/08 13:04:48.145X",
  • "traceNumber": "1234132",
  • "amount": 1234132,
  • "userId": 1234,
  • "createDate": "2023/07/08 13:04:48.145X",
  • "reasonCode": 14,
  • "reasonDesc": "ACCOUNT CLOSED",
  • "comment": "Customer requested return",
  • "commitDate": "2023/07/08 13:04:48.145X",
  • "systemId": 12341,
  • "partitionNumber": 34,
  • "status": "Accepted",
  • "opmtPaymentType": "string",
  • "softRejectCode": {
    },
  • "hardRejectCode": {
    },
  • "customFields": [
    ],
  • "auditEntries": [
    ],
  • "violations": [
    ]
}

Get adjustment

Get the adjustment with the given id.

SecurityJWT
Request
path Parameters
adjustmentId
required
integer <int64>
Responses
200

Success

404

Not found

500

Internal Server Error

get/cw/adjustments/adjustment/{adjustmentId}
Request samples 
Response samples 
{
  • "busUnit": {
    },
  • "busUnitId": 23143,
  • "transactionId": 123434,
  • "importDate": "2023/07/08 13:04:48.145X",
  • "traceNumber": "1234132",
  • "amount": 1234132,
  • "userId": 1234,
  • "createDate": "2023/07/08 13:04:48.145X",
  • "reasonCode": 14,
  • "reasonDesc": "ACCOUNT CLOSED",
  • "comment": "Customer requested return",
  • "commitDate": "2023/07/08 13:04:48.145X",
  • "systemId": 12341,
  • "partitionNumber": 34,
  • "status": "Accepted",
  • "opmtPaymentType": "string",
  • "softRejectCode": {
    },
  • "hardRejectCode": {
    },
  • "customFields": [
    ],
  • "auditEntries": [
    ],
  • "violations": [
    ]
}
Delete adjustment
Delete the adjustment with the given id. The adjustment cannot be deleted if it has already been included in an AR Model


SecurityJWT 
Request 
path Parameters
adjustmentId
required
integer <int64> 
 
Responses 
200
Success


404
Not found


500
Internal Server Error


delete/cw/adjustments/adjustment/{adjustmentId}
Request samples 
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
List Adjustments
Get a list of adjustments


SecurityJWT 
Request 
Request Body schema: 
billerBusUnitId
string
Biller ID of the business unit


 
busUnitId
integer <int32> 
Business unit ID


 
busUnitName
string
Business unit name


 
object
Created On


 
object
Created By


 
externalBusUnitId
string
External ID of the business unit


 
rowLimit
integer <int32> 
Row Limit


 
rowOffset
integer <int32> 
Row Offset


 
rowSortOrder
string
Row Limit


 
object
Transaction Commit Date


 
object
Transaction ID


 
object
Import Date


 
Responses 
200
Success


500
Internal Server Error


post/cw/adjustments/listAdjustments
Request samples 
{
  • "billerBusUnitId": "string",
  • "busUnitId": 0,
  • "busUnitName": "string",
  • "createDate": {
    },
  • "creatorUserId": {
    },
  • "externalBusUnitId": "string",
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string",
  • "transactionCommitDate": {
    },
  • "transactionId": {
    },
  • "transactionImportDate": {
    }
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
➔ Next to Auxiliary Services