Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Adjustment

Retrieves the status of a previously submitted balance adjustment request.

Check the Status of Adjustments to BaaS Account Balances

get/programs/{programCode}/accounts/{accountIdentifier}/adjustments/{adjustmentIdentifier}

Path parameters

programCodestring required

The program code for the partner implementation.

accountIdentifierstring required

The unique identifier for the account.

adjustmentIdentifierstring required

The unique identifier for the adjustment request.

Headers

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request.

Response

OK

adjustmentIdentifierstring uuid nullable

The unique identifier for the adjustment request.

amountnumber double nullable

The amount of the adjustment.

currencystring nullable

The ISO 4217 currency code for the adjustment.

adjustmentTypestring nullable

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

adjustmentDescriptionstring nullable

A description for the adjustment.

feenumber double nullable

The fee amount associated with the adjustment, if applicable.

transactionDatestring nullable

The date and time of the adjustment transaction.

adjustmentStatusstring nullable

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

adjustmentStatusReasonstring nullable

The reason for the current adjustment status, if applicable.

debitToNegativeboolean nullable

Indicates whether the adjustment allowed the account to go negative.