POST//////
Transition a payment schedule to a new status.
URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | 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 |
| payment_schedule_token string Required | 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 |
Request body
| Fields | Description |
|---|---|
| token string Optional | Unique identifier of the payment schedule transition. Allowable Values: 36 char max |
| status string Required | Status of the payment schedule. Allowable Values: ACTIVE, COMPLETED, TERMINATED |
Sample request body
JSON
{
"token": "4749ab00-fec1-471c-ac5b-b8d31d06d7e4",
"status": "TERMINATED"
}
Response body
| Fields | Description |
|---|---|
| token string Conditionally returned | Unique identifier of the payment schedule transition. Allowable Values: 36 char max |
| 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 |
| 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 |
| status string Conditionally returned | Status of the payment schedule. Allowable Values: ACTIVE, COMPLETED, TERMINATED |
| 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 |
| 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
{
"token": "payment_schedule_transition_token_111",
"account_token": "credit_account_token_1232",
"payment_schedule_token": "payment_schedule_token_1232",
"status": "TERMINATED",
"created_time": "2024-01-12T15:03:09.717Z",
"updated_time": "2024-01-12T15:03:09.717Z"
}