/
15 minute read
April 11, 2023

Adjustments

Use the adjustments endpoints to create and retrieve account adjustments on Marqeta’s credit platform. An account adjustment adjusts the amount of a journal entry or account balance.

Creating an adjustment triggers the creation of a journal entry belonging to the ADJUSTMENT group. For more on adjustment journal entries, see Adjustments in the About Credit Account Journal Entries guide.

Create account adjustment

Action: POST
Endpoint: /credit/accounts/{account_token}/adjustments

Create an adjustment for an existing credit account.

URL path parameters

Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to create an adjustment.

Send a GET request to /credit/accounts to retrieve existing credit account tokens.

Allowable Values:

Existing account token

Request body

Fields Description

token

string
Optional

Unique identifier of the adjustment.

Allowable Values:

36 char max

original_ledger_entry_token

uuid
Optional

Unique identifier of the original journal entry needing the adjustment.

Required when adjusting an existing journal entry.

Allowable Values:

Existing journal entry token

external_adjustment_id

uuid
Optional

Unique identifier you provide of an associated external adjustment that exists outside Marqeta’s credit platform.

Allowable Values:

255 char max

amount

decimal
Required

Amount of the adjustment.

Value must be negative if original_ledger_entry_token is not passed.

Allowable Values:

1000000 max

currency_code

string
Required

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

description

string
Required

Description of the adjustment.

Allowable Values:

1–255 chars

note

string
Optional

Additional information on the adjustment.

Allowable Values:

255 char max

reason

string
Optional

Reason for the adjustment.

  • DISPUTE - The adjustment occurred because a dispute was initiated.

  • DISPUTE_RESOLUTION - The adjustment occurred because of the result of a dispute resolution.

  • RETURNED_OR_CANCELED_PAYMENT - The adjustment occurred because a payment was returned or canceled.

  • OTHER - Any other reason the adjustment occurred. For example, a waived fee or account write-off.

Allowable Values:

DISPUTE, DISPUTE_RESOLUTION, RETURNED_OR_CANCELED_PAYMENT, OTHER

Sample request body

JSON
Copied

Is this helpful?

Yes
No

Response body

Fields Description

token

string
Returned

Unique identifier of the adjustment.

If in the detail_object, unique identifier of the detail object.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the credit account on which the adjustment was made.

Allowable Values:

36 char max

Existing account token

type

string
Returned

Type of adjustment.

The adjustment is made on its correlating amount (for example, purchase adjustments are made on purchase amounts). You can use general adjustments for standalone adjustments made on the credit account balance itself, which includes account write-offs, credits, and more.

Allowable Values:

PURCHASE, FEE, REWARD, INTEREST, GENERAL

original_ledger_entry_token

uuid
Conditionally returned

Unique identifier of the original journal entry needing the adjustment.

Allowable Values:

Existing journal entry token

external_adjustment_id

uuid
Conditionally returned

Unique identifier you provide of an associated external adjustment that exists outside Marqeta’s credit platform.

Allowable Values:

255 char max

detail_token

string
Conditionally returned

Unique identifier of the adjustment detail. For example, the token of the dispute, the interest charge, or the returned payment that prompted the adjustment.

Returned when the system automatically applies an adjustment.

Allowable Values:

36 char max

adjustment_detail_object

object
Conditionally returned

Contains the adjustment’s full details.

The fields returned in this object depend on the adjustment type.

Interest returns interest details. For the specific fields returned, see the detail_object fields marked "Returned for interest journal entries" in the account journal entry response fields.

Disputes return dispute details. For the specific fields returned, see the dispute response fields.

Allowable Values:

Existing adjustment_detail_object

related_detail_token

string
Conditionally returned

Unique identifier of the dispute or returned payment that prompted the interest adjustment.

This field is returned for interest adjustments only.

Allowable Values:

36 char max

related_detail_object

object
Conditionally returned

Contains full details of the related dispute or returned payment.

The fields returned in this object depend on whether a dispute or returned payment led to the interest adjustment. A dispute returns dispute details; a returned payment returns payment details.

For more on the dispute details returned, see the dispute response fields.

For more on the returned payment details returned, see the payment response fields.

This field is returned for interest adjustments only.

Allowable Values:

Existing related_detail_object

amount

decimal
Returned

Amount of the adjustment.

Allowable Values:

Format: 0.00

currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

description

string
Returned

Description of the adjustment.

Allowable Values:

1 char min

note

string
Conditionally returned

Additional information on the adjustment.

Allowable Values:

255 char max

reason

string
Returned

Reason for the adjustment.

  • DISPUTE - The adjustment occurred because a dispute was initiated.

  • DISPUTE_RESOLUTION - The adjustment occurred because of the result of a dispute resolution.

  • RETURNED_OR_CANCELED_PAYMENT - The adjustment occurred because a payment was returned or canceled.

  • OTHER - Any other reason the adjustment occurred. For example, a waived fee.

Allowable Values:

DISPUTE, DISPUTE_RESOLUTION, RETURNED_OR_CANCELED_PAYMENT, OTHER

created_time

datetime
Conditionally returned

Date and time when the account adjustment was applied, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON
Copied

Is this helpful?

Yes
No

List account adjustments

Action: GET
Endpoint: /credit/accounts/{account_token}/adjustments

Retrieve an array of adjustments for a credit account.

This endpoint supports pagination.

URL path parameters

Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to retrieve adjustments.

Send a GET request to /credit/accounts to retrieve existing credit account tokens.

Allowable Values:

Existing account token

URL query parameters

Fields Description

count

integer
Optional

The number of resources to retrieve

Allowable Values:

1–100

start_index

integer
Optional

Sort order index of the first resource in the returned array.

Allowable Values:

0 min

Response body

Fields Description

count

integer
Returned

Number of resources returned.

Allowable Values:

1-10

start_index

integer
Returned

Sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

Sort order index of the last resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

data

array of objects
Returned

Contains one or more account adjustments.

Allowable Values:

One or more account adjustment objects

data[].token

string
Returned

Unique identifier of the adjustment.

If in the detail_object, unique identifier of the detail object.

Allowable Values:

36 char max

data[].account_token

string
Returned

Unique identifier of the credit account on which the adjustment was made.

Allowable Values:

36 char max

Existing account token

data[].type

string
Returned

Type of adjustment.

The adjustment is made on its correlating amount (for example, purchase adjustments are made on purchase amounts). You can use general adjustments for standalone adjustments made on the credit account balance itself, which includes account write-offs, credits, and more.

Allowable Values:

PURCHASE, FEE, REWARD, INTEREST, GENERAL

data[].original_ledger_entry_token

uuid
Conditionally returned

Unique identifier of the original journal entry needing the adjustment.

Allowable Values:

Existing journal entry token

data[].external_adjustment_id

uuid
Conditionally returned

Unique identifier you provide of an associated external adjustment that exists outside Marqeta’s credit platform.

Allowable Values:

255 char max

data[].detail_token

string
Conditionally returned

Unique identifier of the adjustment detail. For example, the token of the dispute, the interest charge, or the returned payment that prompted the adjustment.

Returned when the system automatically applies an adjustment.

Allowable Values:

36 char max

data[].adjustment_detail_object

object
Conditionally returned

Contains the adjustment’s full details.

The fields returned in this object depend on the adjustment type.

Interest returns interest details. For the specific fields returned, see the detail_object fields marked "Returned for interest journal entries" in the account journal entry response fields.

Disputes return dispute details. For the specific fields returned, see the dispute response fields.

Allowable Values:

Existing adjustment_detail_object

data[].related_detail_token

string
Conditionally returned

Unique identifier of the dispute or returned payment that prompted the interest adjustment.

This field is returned for interest adjustments only.

Allowable Values:

36 char max

data[].related_detail_object

object
Conditionally returned

Contains full details of the related dispute or returned payment.

The fields returned in this object depend on whether a dispute or returned payment led to the interest adjustment. A dispute returns dispute details; a returned payment returns payment details.

For more on the dispute details returned, see the dispute response fields.

For more on the returned payment details returned, see the payment response fields.

This field is returned for interest adjustments only.

Allowable Values:

Existing related_detail_object

data[].amount

decimal
Returned

Amount of the adjustment.

Allowable Values:

Format: 0.00

data[].currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

data[].description

string
Returned

Description of the adjustment.

Allowable Values:

1 char min

data[].note

string
Conditionally returned

Additional information on the adjustment.

Allowable Values:

255 char max

data[].reason

string
Returned

Reason for the adjustment.

  • DISPUTE - The adjustment occurred because a dispute was initiated.

  • DISPUTE_RESOLUTION - The adjustment occurred because of the result of a dispute resolution.

  • RETURNED_OR_CANCELED_PAYMENT - The adjustment occurred because a payment was returned or canceled.

  • OTHER - Any other reason the adjustment occurred. For example, a waived fee.

Allowable Values:

DISPUTE, DISPUTE_RESOLUTION, RETURNED_OR_CANCELED_PAYMENT, OTHER

data[].created_time

datetime
Conditionally returned

Date and time when the account adjustment was applied, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON
Copied

Is this helpful?

Yes
No

Retrieve account adjustment

Action: GET
Endpoint: /credit/accounts/{account_token}/adjustments/{adjustment_token}

Retrieve an adjustment for a credit account.

URL path parameters

Fields Description

account_token

string
Required

The unique identifier of the credit account for which you want to retrieve an adjustment.

Send a GET request to /credit/accounts to retrieve existing credit account tokens.

Allowable Values:

Existing account token

adjustment_token

string
Required

The unique identifier of the adjustment to retrieve.

Send a GET request to /credit/accounts/{account_token}/adjustments to retrieve existing account adjustment tokens.

Allowable Values:

Existing adjustment token

Response body

Fields Description

token

string
Returned

Unique identifier of the adjustment.

If in the detail_object, unique identifier of the detail object.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the credit account on which the adjustment was made.

Allowable Values:

36 char max

Existing account token

type

string
Returned

Type of adjustment.

The adjustment is made on its correlating amount (for example, purchase adjustments are made on purchase amounts). You can use general adjustments for standalone adjustments made on the credit account balance itself, which includes account write-offs, credits, and more.

Allowable Values:

PURCHASE, FEE, REWARD, INTEREST, GENERAL

original_ledger_entry_token

uuid
Conditionally returned

Unique identifier of the original journal entry needing the adjustment.

Allowable Values:

Existing journal entry token

external_adjustment_id

uuid
Conditionally returned

Unique identifier you provide of an associated external adjustment that exists outside Marqeta’s credit platform.

Allowable Values:

255 char max

detail_token

string
Conditionally returned

Unique identifier of the adjustment detail. For example, the token of the dispute, the interest charge, or the returned payment that prompted the adjustment.

Returned when the system automatically applies an adjustment.

Allowable Values:

36 char max

adjustment_detail_object

object
Conditionally returned

Contains the adjustment’s full details.

The fields returned in this object depend on the adjustment type.

Interest returns interest details. For the specific fields returned, see the detail_object fields marked "Returned for interest journal entries" in the account journal entry response fields.

Disputes return dispute details. For the specific fields returned, see the dispute response fields.

Allowable Values:

Existing adjustment_detail_object

related_detail_token

string
Conditionally returned

Unique identifier of the dispute or returned payment that prompted the interest adjustment.

This field is returned for interest adjustments only.

Allowable Values:

36 char max

related_detail_object

object
Conditionally returned

Contains full details of the related dispute or returned payment.

The fields returned in this object depend on whether a dispute or returned payment led to the interest adjustment. A dispute returns dispute details; a returned payment returns payment details.

For more on the dispute details returned, see the dispute response fields.

For more on the returned payment details returned, see the payment response fields.

This field is returned for interest adjustments only.

Allowable Values:

Existing related_detail_object

amount

decimal
Returned

Amount of the adjustment.

Allowable Values:

Format: 0.00

currency_code

string
Returned

A valid three-digit ISO 4217 currency code

Allowable Values:

USD

description

string
Returned

Description of the adjustment.

Allowable Values:

1 char min

note

string
Conditionally returned

Additional information on the adjustment.

Allowable Values:

255 char max

reason

string
Returned

Reason for the adjustment.

  • DISPUTE - The adjustment occurred because a dispute was initiated.

  • DISPUTE_RESOLUTION - The adjustment occurred because of the result of a dispute resolution.

  • RETURNED_OR_CANCELED_PAYMENT - The adjustment occurred because a payment was returned or canceled.

  • OTHER - Any other reason the adjustment occurred. For example, a waived fee.

Allowable Values:

DISPUTE, DISPUTE_RESOLUTION, RETURNED_OR_CANCELED_PAYMENT, OTHER

created_time

datetime
Conditionally returned

Date and time when the account adjustment was applied, in UTC.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON
Copied

Is this helpful?

Yes
No

Subscribe to our developer newsletter