POST////
Create a new payment schedule, either one-time or recurring.
URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | Unique identifier of the credit account for which you want to create a payment schedule. 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 payment schedule. Allowable Values: 36 char max |
| payment_source_token string Required | Unique identifier of the payment source. Allowable Values: 36 char max Existing payment source token |
| amount_category string Required | A category used to determine the actual payment amount. Allowable Values: FIXED, MINIMUM_PAYMENT, REMAINING_STATEMENT_BALANCE, CURRENT_BALANCE |
| amount decimal Optional | Amount of the payment. Required if amount_category is FIXED.Allowable Values: Format: 0.00 |
| frequency string Required | Defines how often to make a scheduled payment. Allowable Values: ONCE, MONTHLY |
| payment_day string Optional | Day on which monthly payments are made. Required if frequency is MONTHLY.Allowable Values: PAYMENT_DUE_DAY |
| next_payment_impact_date date Optional | Date to make a one-time payment. Required if frequency is ONCE.Allowable Values: Format: yyyy-MM-dd |
| currency_code string Required | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| description string Optional | Description of the payment schedule. Allowable Values: 255 char max |
Sample request body
JSON
{
"token": "payment_schedule_token_1239",
"payment_source_token": "payment_source_token_1112",
"amount_category": "FIXED",
"amount": 100,
"frequency": "MONTHLY",
"payment_day": "PAYMENT_DUE_DAY",
"currency_code": "USD",
"description": "Account statement payment"
}
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the payment schedule. Allowable Values: 36 char max |
| payment_source_token string Returned | Unique identifier of a payment source. Allowable Values: Existing payment source token |
| account_token string Returned | Unique identifier of the credit account on which the payment schedule is made. Allowable Values: Existing account token |
| amount_category string Returned | A category used to determine the actual payment amount. Allowable Values: FIXED, MINIMUM_PAYMENT, REMAINING_STATEMENT_BALANCE, CURRENT_BALANCE |
| status string Returned | Status of the payment schedule. Allowable Values: ACTIVE, COMPLETED, TERMINATED |
| amount decimal Conditionally returned | Amount of the payment. Returned if the amount_category is FIXED.Allowable Values: Format: 0.00 |
| frequency string Returned | Defines how often to make a scheduled payment. Allowable Values: ONCE, MONTHLY |
| payment_day string Conditionally returned | Day on which monthly payments are made. Returned if the frequency is MONTHLY.Allowable Values: PAYMENT_DUE_DAY |
| next_payment_impact_date date Conditionally returned | Date to make a one-time payment. Returned if frequency is ONCE.Allowable Values: Format: yyyy-MM-dd |
| currency_code string Returned | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| description string Conditionally returned | Description of the payment schedule. Allowable Values: 255 char max |
| created_time datetime Conditionally returned | Date and time when the payment schedule 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 was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
JSON
{
"token": "4749ab00-fec1-471c-ac5b-b8d31d06d7e4",
"account_token": "12f10563-d5f2-11ec-889b-bd3a73e55331",
"payment_source_token": "7d68f45b-1232-4283-a0ea-6b0418d37692",
"amount_category": "FIXED",
"status": "COMPLETED",
"amount": 2500,
"frequency": "ONCE",
"next_payment_impact_date": "2024-01-31",
"currency_code": "USD",
"description": "Scheduled account payment",
"created_time": "2024-01-12T15:03:09.717Z"
}