PUT///
Update a credit account.
URL path parameters
| Fields | Description |
|---|---|
| account_token string Required | Unique identifier of the credit account to update. Send a GET request to /credit/accounts to retrieve existing credit account tokens.Allowable Values: Existing account token |
Request body
| Fields | Description |
|---|---|
| config object Optional | Contains information relevant for updating configurations for electronic disclosures, fees, payment holds, and minimum payment. Allowable Values: Existing config object |
| config.e_disclosure_active boolean Optional | A value of true indicates that the account holder consents to receiving disclosures and statements electronically.Allowable Values: true, falseDefault value: false |
| config.fees array of objects Optional | Contains one or more fees associated with the credit account. Allowable Values: One or more fees objects |
| config.fees[].type string Required | Type of fee. Allowable Values: LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, MONTHLY_FEE, ANNUAL_FEE, FOREIGN_TRANSACTION_FEE |
| config.fees[].schedule array of objects Required | Contains one or more fee schedules. Allowable Values: One or more schedule objects |
| config.fees[].schedule[].method string Required | Method used to calculate the fee value. Allowable Values: FLAT, PERCENTAGE |
| config.fees[].schedule[].value decimal Required | Amount of the fee. Allowable Values: 0–9999.99 Format: 0.00 |
| config.fees[].schedule[].effective_date datetime Optional | Date and time when the fee goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| config.payment_holds object Optional | Contains configurations for a payment hold. Allowable Values: Existing payment_holds object |
| config.payment_holds.ach_hold_days integer Optional | Number of days to hold an ACH payment. Allowable Values: 0–30 |
| config.payment_holds.check_hold_days integer Optional | Number of days to hold a check payment. Allowable Values: 0–30 |
| config.payment_due_interval integer Optional | Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date. For consumer programs, a minimum gap of 21 days is required between when a statement is delivered and the payment due date. Allowable Values: -1 min Positive integers greater than 0; -1 is the default value |
| config.min_payment object Optional | Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product. Allowable Values: Existing min_payment object |
| config.min_payment.override_start_time datetime Optional | Date and time when the minimum payment override starts, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| config.min_payment.override_end_time datetime Optional | Date and time when the minimum payment override ends, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| config.min_payment.min_payment_flat_amount decimal Optional | Flat amount of the minimum payment override. Allowable Values: 0 min |
| config.min_payment.min_payment_percentage decimal Optional | Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
| config.min_payment.active boolean Optional | Whether the minimum payment override is currently active. Allowable Values: true, false |
| usages array of objects Optional | Contains one or more usages objects that contain information on how a credit account is used and what types of balances are permitted on the account.You can pass only one usages object per usages.type.Allowable Values: One or more usages objects |
| usages[].type string Required | Type of balance. - PURCHASE - The balance on purchases.Allowable Values: PURCHASE |
| usages[].aprs array of objects Optional | Contains one or more annual percentage rates (APRs) associated with the credit account. Allowable Values: One or more aprs objects |
| usages[].aprs[].type string Required | Type of APR. - GO_TO - Default APR rate that is applicable when any promotional periods expire.- PROMOTIONAL - A temporary rate that is applicable for a specified period of time.Allowable Values: GO_TO, PROMOTIONAL |
| usages[].aprs[].schedule array of objects Required | Contains one or more schedule objects, which contain information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.Allowable Values: One or more schedule objects |
| usages[].aprs[].schedule[].type string Optional | Indicates whether the APR value is fixed or variable. Allowable Values: FIXED, VARIABLE |
| usages[].aprs[].schedule[].margin decimal Optional | Number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: Format: 0.00 |
| usages[].aprs[].schedule[].value decimal Required | Percentage value of the APR. If the APR type is FIXED, this is the value of the fixed rate. If the APR type is VARIABLE, the value is calculated by adding the margin to the prime rate that was stored on Marqeta’s credit platform when your credit program was created.When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
| usages[].aprs[].schedule[].effective_date datetime Optional | Date and time when the APR goes into effect, in UTC. If you do not include a date-time value, the system uses the date and time when the API request was received. NOTE: When passing multiple schedule objects, this field is required in all objects but the first. If you do not include effective_date in the first schedule, the system uses the date and time when the API request was received.Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| usages[].aprs[].schedule[].apply_next_cycle boolean Optional | Whether the APR can be ignored for the current billing cycle and applied on the next. Allowable Values: true, falseDefault value: false |
| credit_limit object Optional | Contains information on the credit limit. Allowable Values: Existing credit_limit object |
| credit_limit.value decimal Required | Maximum balance the credit account can carry. Allowable Values: 0–999999999999.99 |
| user_token string Optional | User token tied to the credit account. You can only update the value of the user token for business accounts. Allowable Values: 255 char max |
| latest_statement_cycle_type string Optional | Type of cycle. - BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.- REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.- END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.- TRANSACTING - Account is not revolving and the balance is paid off each month.Allowable Values: BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTINGNOTE: When creating or updating an account, only TRANSACTING is allowed. |
Sample request body
JSON
{
"config": {
"payment_holds": {
"ach_hold_days": 3,
"check_hold_days": 5
}
},
"credit_limit": {
"value": 6000
},
"latest_statement_cycle_type": "TRANSACTING"
}
Response body
| Fields | Description |
|---|---|
| token string Returned | Unique identifier of the credit account. Allowable Values: 36 char max |
| secured_account_token string Conditionally returned | Unique identifier of the secured account. Allowable Values: 36 char max |
| name string Conditionally returned | Name of the credit account. Allowable Values: 255 char max |
| description string Conditionally returned | Description for the credit account. Allowable Values: 255 char max |
| currency_code string Returned | Valid three-digit ISO 4217 currency code. Allowable Values: USD |
| status string Returned | Status of the credit account. Allowable Values: UNACTIVATED, ACTIVE, SUSPENDED, TERMINATED, CHARGE_OFF |
| substatuses array of strings Conditionally returned | Substatuses of the credit account. Allowable Values: Valid array of one or more credit account substatuses: HARDSHIP, FRAUD, CEASE_AND_DESIST, OPT_OUT |
| user_substatuses array of strings Conditionally returned | Substatuses of the users under the credit account. Allowable Values: Valid array of one or more user substatuses: MLA, SCRA, DECEASED, BANKRUPTCY, POWER_OF_ATTORNEY |
| business_substatuses array of strings Conditionally returned | Substatuses of the business under the credit account. Allowable Values: Valid array of one or more business substatuses: BANKRUPTCY``POWER_OF_ATTORNEY |
| activation_time datetime Conditionally returned | Date and time when the credit account was activated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| created_time datetime Returned | Date and time when the credit account was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| updated_time datetime Returned | Date and time when the credit account was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| type string Returned | Type of credit account. Allowable Values: CONSUMER, BUSINESS |
| bundle_token string Conditionally returned | Unique identifier of the associated bundle product. Allowable Values: Existing bundle token |
| credit_product_token string Conditionally returned | Unique identifier of the associated credit product. Allowable Values: Existing credit product token. Optional if a bundle_token is provided. |
| user_token string Conditionally returned | Unique identifier of the primary account holder or an administrative user of a business account. Either a user_token or business_token is returned, not both.Allowable Values: Existing user token |
| business_token string Conditionally returned | Unique identifier of the parent business program. Either a user_token or business_token is returned, not both.Allowable Values: Existing business token |
| external_offer_id string Conditionally returned | Unique identifier you provide of the associated external credit offer. Allowable Values: Your external offer identifier |
| credit_limit decimal Conditionally returned | Maximum balance the credit account can carry. Optional for light responses. Allowable Values: 0–1000000 |
| current_balance decimal Conditionally returned | Current purchase balance on the credit account. Optional for light responses. Allowable Values: Format: 0.00 |
| available_credit decimal Conditionally returned | Amount of credit available for use on the credit account. Optional for light responses. Allowable Values: Format: 0.00 |
| remaining_statement_balance decimal Conditionally returned | Amount remaining on the latest statement’s balance after it is adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Optional for light responses. Allowable Values: Format: 0.00 |
| remaining_min_payment_due decimal Conditionally returned | Amount remaining on the latest statement’s minimum payment after it is adjusted for payments, returned payments, and applicable credits that occurred after the latest statement’s closing date. Optional for light responses. Allowable Values: Format: 0.00 |
| latest_statement_cycle_type string Conditionally returned | Type of cycle. - BEGINNING_REVOLVING - Account is beginning to revolve and just started carrying a balance from the previous month.- REVOLVING - Account is revolving and has been carrying a balance from month to month for more than one month.- END_REVOLVING - Account is no longer revolving and the previous month’s balance is paid off.- TRANSACTING - Account is not revolving and the balance is paid off each month.Allowable Values: BEGINNING_REVOLVING, REVOLVING, END_REVOLVING, TRANSACTINGNOTE: When creating or updating an account, only TRANSACTING is allowed. |
| config object Returned | Contains information returned when configuring an account’s billing cycle day, payment due day, fees, and more. Allowable Values: Existing config object |
| config.billing_cycle_day integer Returned | Day of the month when the billing cycle starts. If an override value is not provided, the default value is derived from the bundle. Allowable Values: 1–28 |
| config.payment_due_day integer Conditionally returned | Day of the month when the payment for the previous billing cycle is due. Allowable Values: 31 |
| config.payment_due_interval integer Conditionally returned | Specifies the payment due interval that is used to determine the payment due date for a billing cycle. A value of -1 indicates one day prior to the next billing cycle date. Allowable Values: -1 min Positive integers greater than 0; -1 is the default value |
| config.e_disclosure_active boolean Returned | A value of true indicates that the account holder consents to receiving disclosures and statements electronically.Allowable Values: true, false |
| config.card_level string Returned | Level of the credit card. Allowable Values: PREMIUM, TRADITIONAL, NA |
| config.fees array of objects Conditionally returned | Contains one or more fees associated with the credit account. Allowable Values: One or more fees objects |
| config.fees[].type string Conditionally returned | Type of fee. Allowable Values: LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, MONTHLY_FEE, ANNUAL_FEE, FOREIGN_TRANSACTION_FEE |
| config.fees[].active boolean Conditionally returned | Whether the fee is active. Allowable Values: true, false |
| config.fees[].created_date datetime Conditionally returned | Date and time when the fee was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| config.fees[].updated_date datetime Conditionally returned | Date and time when the fee was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| config.fees[].schedule array of objects Conditionally returned | Contains one or more fee schedules. Allowable Values: One or more schedule objects |
| config.fees[].schedule[].method string Returned | Method used to calculate the fee value. Allowable Values: FLAT, PERCENTAGE |
| config.fees[].schedule[].value decimal Returned | Amount of the fee. Allowable Values: 0–9999.99 Format: 0.00 |
| config.fees[].schedule[].effective_date datetime Conditionally returned | Date and time when the fee goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| config.rewards array of objects Conditionally returned | Contains one or more rewards associated with the credit account. Allowable Values: One or more rewards objects |
| config.rewards[].type string Returned | Type of reward. Allowable Values: AUTO_CASH_BACK, CASH_BACK, STATEMENT_CREDIT |
| config.rewards[].method string Returned | Method, either a flat amount or a percentage. NOTE: Only FLAT is currently supported.Allowable Values: PERCENTAGE, FLAT |
| config.rewards[].value decimal Conditionally returned | Value of the reward, either a flat reward amount or percentage value. Allowable Values: 0–100 |
| config.payment_holds object Returned | Contains configurations for a payment hold. Allowable Values: Existing payment_holds object |
| config.payment_holds.ach_hold_days integer Conditionally returned | Number of days to hold an ACH payment. Allowable Values: 0–30 |
| config.payment_holds.check_hold_days integer Conditionally returned | Number of days to hold a check payment. Allowable Values: 0–30 |
| config.min_payment object Conditionally returned | Contains configurations for a minimum payment override on a credit account, which overrides the minimum payment configurations on the associated credit product. Allowable Values: Existing min_payment object |
| config.min_payment.override_start_time datetime Conditionally returned | Date and time when the minimum payment override starts, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| config.min_payment.override_end_time datetime Conditionally returned | Date and time when the minimum payment override ends, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| config.min_payment.min_payment_flat_amount decimal Conditionally returned | Flat amount of the minimum payment override. Allowable Values: 0 min |
| config.min_payment.min_payment_percentage decimal Conditionally returned | Percentage of the total statement balance used to calculate the minimum payment override amount. Allowable Values: 0 min |
| config.min_payment.active boolean Conditionally returned | Whether the minimum payment override is currently active. Allowable Values: true, false |
| usages array of objects Conditionally returned | Contains one or more usages objects that contain information on how a credit account is used and what types of balances are permitted on the account. Optional for light responses.Allowable Values: Valid array of one or more usages objects |
| usages[].type string Returned | Type of balance. - PURCHASE - The balance on purchases.Allowable Values: PURCHASE |
| usages[].aprs array of objects Returned | Contains one or more APRs associated with the type of balance on the credit account. Allowable Values: One or more aprs objects |
| usages[].aprs[].type string Returned | Type of APR. - GO_TO - Default APR rate that is applicable when any promotional periods expire.- PROMOTIONAL - A temporary rate that is applicable for a specified period of time.Allowable Values: GO_TO, PROMOTIONAL |
| usages[].aprs[].active boolean Conditionally returned | Whether the APR is active. Allowable Values: true, false |
| usages[].aprs[].created_date datetime Conditionally returned | Date and time when the APR was created on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| usages[].aprs[].updated_date datetime Conditionally returned | Date and time when the APR was last updated on Marqeta’s credit platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| usages[].aprs[].schedule array of objects Returned | Contains one or more schedule objects, which contain information about the annual percentage rates (APRs) associated with the type of balance on the credit account and when they are effective.Allowable Values: One or more schedule objects |
| usages[].aprs[].schedule[].type string Conditionally returned | Indicates whether the APR value is fixed or variable. Allowable Values: FIXED, VARIABLE |
| usages[].aprs[].schedule[].value decimal Returned | Percentage value of the APR. If the APR type is FIXED, this is the value of the fixed rate. If the APR type is VARIABLE, the value is calculated by adding the margin to the prime rate that was stored on Marqeta’s credit platform when your credit program was created.When backdating an APR, this value cannot be greater than the value of the effective APR on the backdated date. Allowable Values: 0–100 |
| usages[].aprs[].schedule[].margin decimal Conditionally returned | Number of percentage points added to the prime rate, used to calculate a variable value. Used for variable values only. Allowable Values: Format: 0.00 |
| usages[].aprs[].schedule[].effective_date datetime Conditionally returned | Date and time when the APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| usages[].aprs[].schedule[].apply_next_cycle boolean Conditionally returned | Whether the APR is ignored for the current billing cycle and applied on the next. Allowable Values: true, falseDefault value: false |
| usages[].fees array of objects Conditionally returned | Contains one or more fees associated with the usage type. Allowable Values: One or more fees objects |
| usages[].fees[].type string Returned | Type of fee. NOTE: Only RETURNED_PAYMENT_FEE, LATE_PAYMENT_FEE, ANNUAL_FEE, and MONTHLY_FEE are currently supported. Do not pass other fees types.Allowable Values: FOREIGN_TRANSACTION_FEE, OVER_LIMIT_FEE, LATE_PAYMENT_FEE, RETURNED_PAYMENT_FEE, CARD_REPLACEMENT_FEE, MINIMUM_INTEREST_FEE, MINIMUM_INTEREST_FEE_REVERSAL, ANNUAL_FEE, MONTHLY_FEE, ACCOUNT_FEE |
| usages[].fees[].method string Returned | Method, either a flat amount or a percentage. NOTE: Only FLAT is currently supported.Allowable Values: PERCENTAGE, FLAT |
| usages[].fees[].value decimal Conditionally returned | Value of the fee, either a flat fee amount or percentage value. Allowable Values: 0–9999.99 Format: 0.00 |
| max_apr_schedules array of objects Conditionally returned | Contains max_apr_schedule objects, which provide information about any temporary overrides of the APRs on the credit account. This could include special APR rates due to account/user substatus changes.Allowable Values: Valid array of one or more override_schedule objects |
| max_apr_schedules[].value decimal Returned | The APR percentage value. This is the value of the fixed rate during the override period. The APR value must adhere to the constraints of the main schedule, such as maximum allowable values. Allowable Values: 0–100 |
| max_apr_schedules[].start_date datetime Returned | Date and time when the override APR goes into effect, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| max_apr_schedules[].end_date datetime Conditionally returned | Date and time when the override APR ends, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
| max_apr_schedules[].reason string Returned | Reason for the override APR. Allowable Values: SCRA, MLA, HARDSHIP |
Sample response body
JSON
{
"token": "credit_account_token1234",
"name": "John Jacob",
"description": "Consumer credit account for John Jacob",
"currency_code": "USD",
"status": "ACTIVE",
"substatuses": [],
"user_substatuses": [],
"activation_time": "2021-08-26T22:55:52.302Z",
"created_time": "2021-08-26T22:55:52.100Z",
"updated_time": "2021-08-26T22:55:52.304Z",
"type": "CONSUMER",
"credit_product_token": "credit_product_token1234",
"user_token": "user_token1234",
"external_offer_id": "external-offer-11",
"credit_limit": 6000,
"current_balance": 0,
"available_credit": 3232,
"remaining_statement_balance": 2768,
"remaining_min_payment_due": 25,
"latest_statement_cycle_type": "TRANSACTING",
"config": {
"billing_cycle_day": 1,
"payment_due_day": 31,
"card_level": "TRADITIONAL",
"e_disclosure_active": true,
"fees": [
{
"type": "LATE_PAYMENT_FEE",
"active": true,
"created_date": "2021-08-26T22:55:52.124Z",
"updated_date": "2021-08-26T22:55:52.124Z",
"schedule": [
{
"method": "FLAT",
"value": 25
}
]
},
{
"type": "RETURNED_PAYMENT_FEE",
"active": true,
"created_date": "2021-09-03T19:06:27.946Z",
"updated_date": "2021-09-03T19:06:27.946Z",
"schedule": [
{
"method": "FLAT",
"value": 10,
"effective_date": "2021-09-03T19:06:27.946Z"
}
]
},
{
"type": "FOREIGN_TRANSACTION_FEE",
"active": true,
"created_date": "2021-09-03T19:06:27.946Z",
"updated_date": "2021-09-03T19:06:27.946Z",
"schedule": [
{
"method": "PERCENTAGE",
"value": 12.5
}
]
}
],
"rewards": [],
"payment_holds": {
"ach_hold_days": 3,
"check_hold_days": 5
}
},
"usages": [
{
"type": "PURCHASE",
"aprs": [
{
"type": "GO_TO",
"active": true,
"created_date": "2021-08-26T22:55:52.106Z",
"updated_date": "2021-08-26T22:55:52.106Z",
"schedule": [
{
"value": 14.99,
"effective_date": "2021-08-26T22:55:52.106Z"
}
]
}
],
"fees": []
}
],
"max_apr_schedules": []
}