Account Balance Adjust V1

This adjustment API call will apply an update to the relevant account balance using the adjustment amount provided. The amount provided will not become the new balance, but will be used to adjust the current balance by that amount. For example, if an account had $500.00 available and you applied an adjustment of "-10.00", then the available amount would now be $490.00.

Appropriate adjustment amounts will be enforced based on the tranCode provided. For example, you cannot provide a positive amount of "1.00" for a Verification ACH Debit (DOBKLVAD), since that is a debiting tranCode that should reduce the available amount on the account instead of adding to it. Instead, you would be required to provide a negative amount of "-1.00" for a Verification ACH Debit.

Body Params
string
Defaults to customer-account

customer-account

string
Defaults to account-balance

account-balance

string
Defaults to adjust

adjust

int32
Defaults to 1

1

string

The unique identifier that pertains to a particular session and is used to validate permissions

Data type: uuid
Required: yes
Letters: no
Numbers: yes
Special: yes
Min: 36
Max: 36

string

Identifier for tracking this API call

Data type: uuid
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 36
Max: 36

string

If account Uuid is not provided, payment instrument reference number must be provided

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

string

If payment instrument reference number is not provided, account Uuid must be provided

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 12
Max: 50

float

Dollar amount being adjusted for the account. This may be a positive or negative value, depending the selected tranCode.

Data type: money
Required: yes
Letters: no
Numbers: yes
Special: yes
Min: 4
Max: 25

string

The transaction description to use in the transaction log, if a custom description is desired

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 1
Max: 20

string
enum

Accepted tran codes for balance adjustments:
CIBKLVAC = Verification ACH Credit
DOBKLVAD = Verification ACH Debit
CIVSCCAP = Credit ACH Payment
CIVSCCMP = Credit Mobile Payment
CIVSCCTP = Credit Telephone Payment
CIVSCCBP = Credit Branch Payment
CIVSCCCP = Credit Check Payment

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 8
Max: 40

Allowed:
boolean
Defaults to false
Response

Language
Response
Choose an example:
application/json