/
5 minute read
September 1, 2022

Account Transitions

Use the /credit/accounts/{account_token}/accounttransitions endpoint to create an account transition on Marqeta’s credit platform, which transitions a credit account to a new status.

To receive webhook notifications when account transition events occur, see Credit account transition events in Event Types.

Transition account status

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

Transition a credit account to a new status.

URL path parameters
Fields Description

account_token

string
Required

The unique identifier of the credit account for which to transition a status.

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

Allowable Values:

Existing account token

Request body
Fields Description

status

string
Required

Status of the credit account.

NOTE CHARGE_OFF is not an allowable value for original_status.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

token

string
Optional

Unique identifier of the credit account transition.

Allowable Values:

36 char max

Sample request body
JSON
Copied

Is this helpful?

Yes
No
Response body
Fields Description

token

string
Returned

Unique identifier of the credit account transition.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the credit account for which to transition a status.

Allowable Values:

36 char max

original_status

string
Returned

Status of the credit account prior to transition.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

status

string
Returned

Status to which the credit account transitioned.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

created_time

datetime
Returned

Date and time when the transition record was created on Marqeta’s credit platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No

List account transitions

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

Retrieve an array of transitions on a credit account.

This endpoint supports sorting and pagination.

URL path parameters
Fields Description

account_token

string
Required

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

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

Allowable Values:

URL query parameters
Fields Description

count

integer
Optional

The number of resources to retrieve.

Allowable Values:

1–100

start_index

integer
Optional

The sort order index of the first resource in the returned array.

Allowable Values:

0 min

sort_by

string
Optional

Field on which to sort. Prefix the field name with a hyphen (-) to sort in descending order. Omit the hyphen to sort in ascending order.

NOTE: You must sort using system field names such as createdTime, and not by the field names appearing in response bodies such as created_time.

Allowable Values:

createdTime, -createdTime

Response body
Fields Description

count

integer
Returned

The number of resources returned.

Allowable Values:

start_index

integer
Returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

end_index

integer
Returned

The 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 transitions.

Allowable Values:

One or more account transition objects

data[].token

string
Returned

Unique identifier of the credit account transition.

Allowable Values:

36 char max

data[].account_token

string
Returned

Unique identifier of the credit account for which to transition a status.

Allowable Values:

36 char max

data[].original_status

string
Returned

Status of the credit account prior to transition.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

data[].status

string
Returned

Status to which the credit account transitioned.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

data[].created_time

datetime
Returned

Date and time when the transition record was created on Marqeta’s credit platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No

Retrieve account transition

Action: GET
Endpoint: /credit/accounts/{account_token}/accounttransitions/{token}

Retrieve a transition 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 a transition.

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

Allowable Values:

Existing account token

token

string
Required

The unique identifier of the account transition you want to retrieve.

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

Allowable Values:

Existing account transition token

Response body
Fields Description

token

string
Returned

Unique identifier of the credit account transition.

Allowable Values:

36 char max

account_token

string
Returned

Unique identifier of the credit account for which to transition a status.

Allowable Values:

36 char max

original_status

string
Returned

Status of the credit account prior to transition.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

status

string
Returned

Status to which the credit account transitioned.

Allowable Values:

UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF

created_time

datetime
Returned

Date and time when the transition record was created on Marqeta’s credit platform.

Allowable Values:

Format: yyyy-MM-dd’T’HH:mm:ss.Z

Sample response body
JSON
Copied

Is this helpful?

Yes
No
Join our developer newsletter