GET//////
Retrieve an array of payment schedule transitions on a specific credit account.
URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | Unique identifier of the credit account for which you want to retrieve payment schedule transitions. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
| payment_schedule_token string Required | Unique identifier of the payment schedule for which you want to retrieve transitions. Send a GET request to /credit/accounts/{account_token}/paymentschedules to retrieve existing payment schedule tokens.Allowable Values: Existing payment schedule token |
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of payment schedule resources to retrieve. Allowable Values: 1 min |
| start_index integer Optional | 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 | 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 | List of payment schedule transitions. Allowable Values: Valid array of one or more payment schedule transition objects |
| data[].token string Conditionally returned | Unique identifier of the payment schedule transition. Allowable Values: 36 char max |
| data[].account_token string Conditionally returned | Unique identifier of the credit account on which to transition a payment schedule. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
| data[].payment_schedule_token string Conditionally returned | Unique identifier of the payment schedule whose status is to transition. Send a GET request to /credit/accounts/{account_token}/paymentschedules to retrieve existing payment schedule tokens.Allowable Values: Existing payment schedule token |
| data[].status string Conditionally returned | Status of the payment schedule. Allowable Values: ACTIVE, COMPLETED, TERMINATED |
| data[].created_time datetime Conditionally returned | Date and time when the payment schedule transition was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| data[].updated_time datetime Conditionally returned | Date and time when the payment schedule transition was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"count": 2,
"start_index": 0,
"end_index": 1,
"is_more": false,
"data": [
{
"token": "transition1",
"account_token": "account1",
"payment_schedule_token": "payment1",
"status": "TERMINATED",
"created_time": "2023-08-23T11:25:34.342Z",
"updated_time": "2023-08-23T11:25:34.342Z"
},
{
"token": "transition2",
"account_token": "account2",
"payment_schedule_token": "payment2",
"status": "ACTIVE",
"created_time": "2023-08-22T22:17:11.407Z",
"updated_time": "2023-08-22T22:17:11.407Z"
}
]
}