v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

Adjustment

Creates a balance adjustment for the specified account. Supports adjustment types such as promo, instructionCredit, disbursement, achOut, and their reversals.

The following adjustment types must be specifically configured for a program code in order to be used by a partner.

If an adjustmentType has not been configured for a program code, then the request will be rejected.

If you have any further questions, please contact your Green Dot Product liaisons. Request Parameters.

post/programs/{programCode}/accounts/{accountIdentifier}/adjustments

programCodestring required

The program code for the partner implementation.

accountIdentifierstring required

The unique identifier for the account to adjust.

X-GD-MaxRetryDurationstring

The maximum retry duration for the adjustment operation (optional).

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request.

X-GD-CallModestring

The call mode for AB testing or routing (optional).

adjustmentIdentifierstring nullable

The unique identifier for the adjustment request.

amountnumber double

The amount to adjust (positive for credit, negative for debit).

currencystring nullable

The ISO 4217 currency code for the adjustment (e.g., "USD").

adjustmentTypestring nullable

The type of adjustment (e.g., promo, disbursement, achOut, or their reversals).

adjustmentDescriptionstring nullable

A description for the adjustment, such as the reason or reference for the transaction.

feenumber double

The fee amount associated with the adjustment, if applicable.

debitToNegativeboolean nullable

Indicates whether the adjustment allows the account to go negative (debit-to-negative).

adjustmentStatusstring nullable

The status of the adjustment (e.g., "pending", "completed", "failed").

adjustmentStatusReasonstring nullable

The reason for the current adjustment status, if applicable.

adjustmentIdentifierstring nullable

The unique identifier for the adjustment request.