API Reference

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

post
https://example.com/programs//accounts//adjustments

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

  • promo and promoReversal
  • instructionCredit and instructionDebit
  • disbursement, disbursementReversal
  • anyDebitOut, anyDebitOutReversal
  • achOut, achOutReversal

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.

Path Params
string
required

The program code for the partner implementation.

string
required

The unique identifier for the account to adjust.

Body Params

The Gd.Bos.DataTransfer.Request.AdjustBalanceRequest containing adjustment details such as amount, type, and description.

string | null

The unique identifier for the adjustment request.

double

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

string | null

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

string | null

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

string | null

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

double

The fee amount associated with the adjustment, if applicable.

boolean | null

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

Headers
string

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

string
required

A unique identifier (GUID) for tracking the request.

string

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago