> ## Documentation Index
> Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Credit Substatuses
> Use the substatus endpoints to apply or remove a substatus for a credit account or user.
export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => {
const METHOD_STYLES = {
GET: {
bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20",
text: "mint-text-green-700 dark:mint-text-green-400",
border: "mint-border-green-300 dark:mint-border-green-700"
},
POST: {
bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20",
text: "mint-text-blue-700 dark:mint-text-blue-400"
},
PUT: {
bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20",
text: "mint-text-yellow-700 dark:mint-text-yellow-400"
},
PATCH: {
bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20",
text: "mint-text-orange-700 dark:mint-text-orange-400"
},
DELETE: {
bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20",
text: "mint-text-red-700 dark:mint-text-red-400"
},
API: {
bg: "mint-bg-black",
text: "mint-text-white"
}
};
const MethodBadge = ({method}) => {
const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET;
return
{method?.toUpperCase()}
;
};
const content =
{}
{}
{title}
{children &&
{children}
}
Create substatus
**Action:** `POST`\
**Endpoint:** `/credit/substatuses`
Create a new substatus for a credit account, user, or business.
Request body
| Fields | Description |
| --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Optional | Unique identifier of the credit substatus.
**Allowable Values:**
36 char max |
| substatus
string
Required | Type of substatus.
- `HARDSHIP`, `FRAUD`, `CEASE_AND_DESIST`, `BLOCKED`, and `OPT_OUT` can only be applied to the `ACCOUNT` resource type.
- `MLA`, `SCRA` and `DECEASED` can only be applied to the `USER` resource type.
- `POWER_OF_ATTORNEY` and `BANKRUPTCY` can be applied to either the `USER` or the `BUSINESS` resource type.
**Allowable Values:**
1–36 chars
`HARDSHIP`, `FRAUD`, `MLA`, `SCRA`, `DECEASED`, `POWER_OF_ATTORNEY`, `CEASE_AND_DESIST`, `OPT_OUT`, `BANKRUPTCY`, `BLOCKED` |
| resource\_type
string
Required | Type of resource to which the substatus can be applied.
**Allowable Values:**
`USER`, `ACCOUNT`, `BUSINESS` |
| resource\_token
string
Required | Unique identifier of the user or account or business for which you want to create a substatus.
- Send a `GET` request to `/credit/accounts` to retrieve existing account tokens.
- Send a `GET` request to `/users` to retrieve existing user tokens.
- Send a `GET` request to `/business` to retrieve existing business tokens.
**Allowable Values:**
1–36 chars |
| attributes
array of objects
Optional | Additional dynamic attributes related to the substatus. If the substatus is `BANKRUPTCY`, `SCRA` or `POWER_OF_ATTORNEY`, then attributes are required.
**Allowable Values:**
`key`, `value` |
| attributes\[].**key**
string
Optional | The name of the attribute.
Marqeta provides several preconfigured attributes, as described in the following list.
- **chapter:** If the substatus is `BANKRUPTCY`, then the chapter attribute is required. `CHAPTER_9` is not applicable to a `USER` resource type. `CHAPTER_13` is not applicable to a `BUSINESS` resource type.
- **military\_start\_date:** If the substatus is `SCRA`, then the military start date attribute is required. The 6% APR override will be applied from the time and date of account opening until the last statement period of the military start date.
- **end\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the end date attribute is applicable. This specifies the date when the power of attorney document is no longer valid.
- **poa\_details:** If the substatus is `POWER_OF_ATTORNEY`, then the Power of Attorney details attribute is applicable. This attribute specifies the range of actions that the agent with Power of Attorney is able to perform on the account. By default the range is `UNRESTRICTED`.
- **agent\_name:** If the substatus is `POWER_OF_ATTORNEY`, then the agent name is required. This attribute specifies the name of the agent with Power of Attorney for the user.
- **agent\_address:** If the substatus is `POWER_OF_ATTORNEY`, then the agent address attribute is required. This attribute specifies the address of the agent with Power of Attorney for the user.
- **agent\_id\_type:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification type attribute is required. This specifies the type of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_value:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification value attribute is required. This attribute specifies the value of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_expiration\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the attribute for the Power of Attorney identification expiration date attribute is required. This attribute specifies the expiration date of the identification method used to identify the agent with Power of Attorney for the user.
**Allowable Values:**
- `chapter`
- `military_start_date`
- `end_date`
- `poa_details`
- `agent_name`
- `agent_address`
- `agent_id_type`
- `agent_id_value`
- `agent_id_expiration_date` |
| attributes\[].**value**
string
Optional | The value of the attribute.
**Allowable Values:**
- **chapter:**`CHAPTER_7`, `CHAPTER_9`, `CHAPTER_11`, `CHAPTER_12`, `CHAPTER_13`
- **military\_start\_date:** yyyy-MM-ddThh:mm:ssZ format
- **end\_date:** yyyy-MM-ddThh:mm:ssZ format
- **poa\_details:** string (255 char max)
- **agent\_name:** string (255 char max)
- **agent\_address:** string (255 char max)
- **agent\_id\_type:**`SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE`
- **agent\_id\_value:** string (255 char max)
- **agent\_id\_expiration\_date:** yyyy-MM-ddThh:mm:ssZ format |
| events
array of objects
Required | List of events related to the substatus.
**Allowable Values:**
Valid array of one or more substatus events |
| events\[].**state**
string
Required | Initial state of the substatus.
- `ACTIVE` - Required if the substatus is `HARDSHIP`, `MLA`, `SCRA`, `DECEASED`, `BLOCKED`, `CEASE_AND_DESIST`, `OPT_OUT`, or `POWER_OF_ATTORNEY`.
- `BANKRUPTCY_FILED` - Required if the substatus is `BANKRUPTCY`.
- `DECEASED_REPORTED` - Required if the substatus is `DECEASED`.
- `FRAUD_REPORTED` - Required if the substatus is `FRAUD`.
**Allowable Values:**
`ACTIVE`, `BANKRUPTCY_FILED`, `DECEASED_REPORTED`, `FRAUD_REPORTED` |
| events\[].**channel**
string
Optional | The mechanism by which the state of the substatus was applied.
- `ADMIN` - Indicates that the state of the substatus was added through the Marqeta Dashboard.
- `API` - Indicates that you initiated an update of the substatus through the Core API. Use this value when creating a substatus.
- `FRAUD` - Indicates that either Marqeta or the card network has determined that the account is fraudulent.
- `SYSTEM` - Indicates that Marqeta initiated the state of the substatus. For example, Marqeta determined during application decisioning that the applicant is `MLA`.
**Allowable Values:**
`ADMIN`, `API`, `FRAUD`, `SYSTEM`
**Default value:**
`API` |
| events\[].**reason**
string
Optional | Reason for applying a state designation to the substatus.
**Allowable Values:**
255 char max |
| events\[].**effective\_date**
datetime
Optional | Date and time when the state of the substatus went into effect, in UTC. The effective date must be in the past. If no value is set, then the effective date and time will be the current time.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
Sample request body
```json JSON lines wrap theme={null}
{
"resource_type": "USER",
"resource_token": "my_user_token",
"substatus": "SCRA",
"attributes": [
{
"key": "military_start_date",
"value": "2024-04-02T11:23:23Z"
}
],
"events": [
{
"state": "ACTIVE",
"channel": "ADMIN",
"reason": "Documents submitted and verified"
}
]
}
```
Response body
| Fields | Description |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Returned | Unique identifier of the credit substatus.
**Allowable Values:**
36 char max |
| resource\_type
string
Returned | Type of resource to which the substatus is applied.
**Allowable Values:**
`ACCOUNT`, `USER`, `BUSINESS` |
| resource\_token
string
Returned | Unique identifier of the resource.
**Allowable Values:**
36 char max |
| substatus
string
Returned | Type of substatus.
**Allowable Values:**
36 char max
- `HARDSHIP`
- `FRAUD`
- `MLA`
- `SCRA`
- `DECEASED`
- `BANKRUPTCY`
- `POWER_OF_ATTORNEY`
- `BLOCKED`
- `CEASE_AND_DESIST`
- `OPT_OUT` |
| state
string
Returned | Current state of the substatus.
**Allowable Values:**
`ACTIVE`, `INACTIVE`, `DECEASED_REPORTED`, `DECEASED_CONFIRMED`, `FRAUD_REPORTED`, `FRAUD_CONFIRMED`, `BANKRUPTCY_FILED`, `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, `BANKRUPTCY_DISMISSED_INACTIVE` |
| is\_active
boolean
Returned | Denotes whether a substatus is active.
**Allowable Values:**
`true`, `false` |
| attributes
array of objects
Conditionally returned | Additional dynamic attributes related to the substatus.
If the substatus is `BANKRUPTCY`, `SCRA`, or `POWER_OF_ATTORNEY`, then attributes are present.
**Allowable Values:**
`key`, `value` |
| attributes\[].**key**
string
Conditionally returned | The name of the attribute.
Marqeta provides several preconfigured attributes, as described in the following list.
- **chapter:** If the substatus is `BANKRUPTCY`, then this value defines the chapter.
- **military\_start\_date:** If the substatus is `SCRA`, then this value defines the military start date.
- **end\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the end date attribute is present. This specifies the date when the power of attorney document is no longer valid.
- **poa\_details:** If the substatus is `POWER_OF_ATTORNEY`, then the Power of Attorney details attribute is applicable. This attribute specifies the range of actions that the agent with Power of Attorney is able to perform on the account. By default the range is `UNRESTRICTED`.
- **agent\_name:** If the substatus is `POWER_OF_ATTORNEY`, then the agent name is present. This attribute specifies the name of the agent with Power of Attorney for the user.
- **agent\_address:** If the substatus is `POWER_OF_ATTORNEY`, then the agent address attribute is present. This attribute specifies the address of the agent with Power of Attorney for the user.
- **agent\_id\_type:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification type attribute is present. This specifies the type of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_value:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification value attribute is present. This attribute specifies the value of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_expiration\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the attribute for the Power of Attorney identification expiration date attribute is present. This attribute specifies the expiration date of the identification method used to identify the agent with Power of Attorney for the user.
**Allowable Values:**
- `chapter`
- `military_start_date`
- `end_date`
- `poa_details`
- `agent_name`
- `agent_address`
- `agent_id_type`
- `agent_id_value`
- `agent_id_expiration_date` |
| attributes\[].**value**
string
Conditionally returned | The value of the attribute.
**Allowable Values:**
- **chapter:**`CHAPTER_7`, `CHAPTER_11`, `CHAPTER_12`, `CHAPTER_13`
- **military\_start\_date:** yyyy-MM-ddThh:mm:ssZ format
- **end\_date:** yyyy-MM-ddThh:mm:ssZ format
- **poa\_details:** string (255 char max)
- **agent\_name:** string (255 char max)
- **agent\_address:** string (255 char max)
- **agent\_id\_type:**`SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE`
- **agent\_id\_value:** string (255 char max)
- **agent\_id\_expiration\_date:** yyyy-MM-ddThh:mm:ssZ format |
| created\_time
datetime
Conditionally returned | Date and time when the substatus 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 substatus was last updated on Marqeta’s credit platform, in UTC.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
| events
array of objects
Conditionally returned | List of events related to the substatus.
**Allowable Values:**
Valid array of one or more substatus events |
| events\[].**state**
string
Returned | The state of the event.
**Allowable Values:**
`ACTIVE`, `INACTIVE`, `DECEASED_REPORTED`, `DECEASED_CONFIRMED`, `FRAUD_REPORTED`, `FRAUD_CONFIRMED`, `BANKRUPTCY_FILED`, `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, `BANKRUPTCY_DISMISSED_INACTIVE` |
| events\[].**channel**
string
Returned | The channel through which the event occurred.
**Allowable Values:**
`ADMIN`, `API`, `FRAUD`, `SYSTEM` |
| events\[].**reason**
string
Conditionally returned | Reason for the event.
**Allowable Values:**
255 char max |
| events\[].**effective\_date**
datetime
Returned | Effective date of the event, in UTC.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
| events\[].**created\_time**
datetime
Returned | Creation time of the event.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
```json JSON expandable lines wrap theme={null}
{
"token": "substatus_token",
"resource_type": "USER",
"resource_token": "my_user_token",
"substatus": "SCRA",
"state": "ACTIVE",
"is_active": true,
"attributes": [
{
"key": "military_start_date",
"value": "2024-04-02T11:23:23Z"
}
],
"created_time": "2024-05-17T21:50:13.729Z",
"updated_time": "2024-05-17T21:51:39.774Z",
"events": [
{
"state": "ACTIVE",
"channel": "ADMIN",
"reason": "Documents submitted and verified",
"effective_date": "2024-05-17T21:50:13.738Z",
"created_time": "2024-05-17T21:50:13.740Z"
}
]
}
```
List substatuses
**Action:** `GET`\
**Endpoint:** `/credit/substatuses`
Retrieve an array of substatuses. This endpoint supports [sorting and pagination](/core-api/sorting-and-pagination/).
URL query parameters
| Fields | Description |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| account\_token
string
Optional | Unique identifier of the account for which to retrieve substatuses.
Send a `GET` request to `/credit/accounts` to retrieve existing account tokens.
**Allowable Values:**
Existing account token |
| user\_token
string
Optional | Unique identifier of the user for which to retrieve substatuses.
Send a `GET` request to `/users` to retrieve existing user tokens.
**Allowable Values:**
Existing user token |
| is\_active
boolean
Optional | Denotes whether a substatus is active.
**Allowable Values:**
`true`, `false` |
| substatuses
array of strings
Optional | Comma-delimited list of substatus types to include. Allowable values: `HARDSHIP`, `FRAUD`, `MLA`, `SCRA`, `DECEASED`, `BANKRUPTCY`, `POWER_OF_ATTORNEY`, `BLOCKED`, `CEASE_AND_DESIST`, `OPT_OUT`
**Allowable Values:**
`HARDSHIP`, `FRAUD`, `MLA`, `SCRA`, `DECEASED`, `BANKRUPTCY`, `POWER_OF_ATTORNEY`, `BLOCKED`, `CEASE_AND_DESIST`, `OPT_OUT` |
| count
integer
Optional | The number of resources to retrieve.
**Allowable Values:**
1–100 |
| 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.
**Allowable Values:**
`createdTime`, `-createdTime` |
Response body
| Fields | Description |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| count
integer
Returned | Number of resources returned.
**Allowable Values:**
1-100 |
| 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 | Contains one or more substatuses.
**Allowable Values:**
`token`, `resource_type`, `resource_token`, `substatus`, `state`, `is_active`, `attributes`, `created_time`, `updated_time`, `events`. |
| data\[].**token**
string
Returned | Unique identifier of the credit substatus.
**Allowable Values:**
36 char max |
| data\[].**resource\_type**
string
Returned | Type of resource to which the substatus is applied.
**Allowable Values:**
`ACCOUNT`, `USER`, `BUSINESS` |
| data\[].**resource\_token**
string
Returned | Unique identifier of the resource.
**Allowable Values:**
36 char max |
| data\[].**substatus**
string
Returned | Type of substatus.
**Allowable Values:**
36 char max
- `HARDSHIP`
- `FRAUD`
- `MLA`
- `SCRA`
- `DECEASED`
- `BANKRUPTCY`
- `POWER_OF_ATTORNEY`
- `BLOCKED`
- `CEASE_AND_DESIST`
- `OPT_OUT` |
| data\[].**state**
string
Returned | Current state of the substatus.
**Allowable Values:**
`ACTIVE`, `INACTIVE`, `DECEASED_REPORTED`, `DECEASED_CONFIRMED`, `FRAUD_REPORTED`, `FRAUD_CONFIRMED`, `BANKRUPTCY_FILED`, `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, `BANKRUPTCY_DISMISSED_INACTIVE` |
| data\[].**is\_active**
boolean
Returned | Denotes whether a substatus is active.
**Allowable Values:**
`true`, `false` |
| data\[].**attributes**
array of objects
Conditionally returned | Additional dynamic attributes related to the substatus.
If the substatus is `BANKRUPTCY`, `SCRA`, or `POWER_OF_ATTORNEY`, then attributes are present.
**Allowable Values:**
`key`, `value` |
| data\[].attributes\[].**key**
string
Conditionally returned | The name of the attribute.
Marqeta provides several preconfigured attributes, as described in the following list.
- **chapter:** If the substatus is `BANKRUPTCY`, then this value defines the chapter.
- **military\_start\_date:** If the substatus is `SCRA`, then this value defines the military start date.
- **end\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the end date attribute is present. This specifies the date when the power of attorney document is no longer valid.
- **poa\_details:** If the substatus is `POWER_OF_ATTORNEY`, then the Power of Attorney details attribute is applicable. This attribute specifies the range of actions that the agent with Power of Attorney is able to perform on the account. By default the range is `UNRESTRICTED`.
- **agent\_name:** If the substatus is `POWER_OF_ATTORNEY`, then the agent name is present. This attribute specifies the name of the agent with Power of Attorney for the user.
- **agent\_address:** If the substatus is `POWER_OF_ATTORNEY`, then the agent address attribute is present. This attribute specifies the address of the agent with Power of Attorney for the user.
- **agent\_id\_type:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification type attribute is present. This specifies the type of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_value:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification value attribute is present. This attribute specifies the value of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_expiration\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the attribute for the Power of Attorney identification expiration date attribute is present. This attribute specifies the expiration date of the identification method used to identify the agent with Power of Attorney for the user.
**Allowable Values:**
- `chapter`
- `military_start_date`
- `end_date`
- `poa_details`
- `agent_name`
- `agent_address`
- `agent_id_type`
- `agent_id_value`
- `agent_id_expiration_date` |
| data\[].attributes\[].**value**
string
Conditionally returned | The value of the attribute.
**Allowable Values:**
- **chapter:**`CHAPTER_7`, `CHAPTER_11`, `CHAPTER_12`, `CHAPTER_13`
- **military\_start\_date:** yyyy-MM-ddThh:mm:ssZ format
- **end\_date:** yyyy-MM-ddThh:mm:ssZ format
- **poa\_details:** string (255 char max)
- **agent\_name:** string (255 char max)
- **agent\_address:** string (255 char max)
- **agent\_id\_type:**`SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE`
- **agent\_id\_value:** string (255 char max)
- **agent\_id\_expiration\_date:** yyyy-MM-ddThh:mm:ssZ format |
| data\[].**created\_time**
datetime
Conditionally returned | Date and time when the substatus 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 substatus was last updated on Marqeta’s credit platform, in UTC.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
| data\[].**events**
array of objects
Conditionally returned | List of events related to the substatus.
**Allowable Values:**
Valid array of one or more substatus events |
| data\[].events\[].**state**
string
Returned | The state of the event.
**Allowable Values:**
`ACTIVE`, `INACTIVE`, `DECEASED_REPORTED`, `DECEASED_CONFIRMED`, `FRAUD_REPORTED`, `FRAUD_CONFIRMED`, `BANKRUPTCY_FILED`, `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, `BANKRUPTCY_DISMISSED_INACTIVE` |
| data\[].events\[].**channel**
string
Returned | The channel through which the event occurred.
**Allowable Values:**
`ADMIN`, `API`, `FRAUD`, `SYSTEM` |
| data\[].events\[].**reason**
string
Conditionally returned | Reason for the event.
**Allowable Values:**
255 char max |
| data\[].events\[].**effective\_date**
datetime
Returned | Effective date of the event, in UTC.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
| data\[].events\[].**created\_time**
datetime
Returned | Creation time of the event.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
Retrieve substatus
**Action:** `GET`\
**Endpoint:** `/credit/substatuses/{substatus_token}`
Retrieve a user or account substatus.
URL path parameters
| Fields | Description |
| ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| substatus\_token
string
Required | Unique identifier of the substatus to retrieve.
Send a `GET` request to `/credit/substatuses` to retrieve existing substatus tokens.
**Allowable Values:**
Existing substatus token |
Response body
| Fields | Description |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Returned | Unique identifier of the credit substatus.
**Allowable Values:**
36 char max |
| resource\_type
string
Returned | Type of resource to which the substatus is applied.
**Allowable Values:**
`ACCOUNT`, `USER`, `BUSINESS` |
| resource\_token
string
Returned | Unique identifier of the resource.
**Allowable Values:**
36 char max |
| substatus
string
Returned | Type of substatus.
**Allowable Values:**
36 char max
- `HARDSHIP`
- `FRAUD`
- `MLA`
- `SCRA`
- `DECEASED`
- `BANKRUPTCY`
- `POWER_OF_ATTORNEY`
- `BLOCKED`
- `CEASE_AND_DESIST`
- `OPT_OUT` |
| state
string
Returned | Current state of the substatus.
**Allowable Values:**
`ACTIVE`, `INACTIVE`, `DECEASED_REPORTED`, `DECEASED_CONFIRMED`, `FRAUD_REPORTED`, `FRAUD_CONFIRMED`, `BANKRUPTCY_FILED`, `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, `BANKRUPTCY_DISMISSED_INACTIVE` |
| is\_active
boolean
Returned | Denotes whether a substatus is active.
**Allowable Values:**
`true`, `false` |
| attributes
array of objects
Conditionally returned | Additional dynamic attributes related to the substatus.
If the substatus is `BANKRUPTCY`, `SCRA`, or `POWER_OF_ATTORNEY`, then attributes are present.
**Allowable Values:**
`key`, `value` |
| attributes\[].**key**
string
Conditionally returned | The name of the attribute.
Marqeta provides several preconfigured attributes, as described in the following list.
- **chapter:** If the substatus is `BANKRUPTCY`, then this value defines the chapter.
- **military\_start\_date:** If the substatus is `SCRA`, then this value defines the military start date.
- **end\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the end date attribute is present. This specifies the date when the power of attorney document is no longer valid.
- **poa\_details:** If the substatus is `POWER_OF_ATTORNEY`, then the Power of Attorney details attribute is applicable. This attribute specifies the range of actions that the agent with Power of Attorney is able to perform on the account. By default the range is `UNRESTRICTED`.
- **agent\_name:** If the substatus is `POWER_OF_ATTORNEY`, then the agent name is present. This attribute specifies the name of the agent with Power of Attorney for the user.
- **agent\_address:** If the substatus is `POWER_OF_ATTORNEY`, then the agent address attribute is present. This attribute specifies the address of the agent with Power of Attorney for the user.
- **agent\_id\_type:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification type attribute is present. This specifies the type of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_value:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification value attribute is present. This attribute specifies the value of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_expiration\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the attribute for the Power of Attorney identification expiration date attribute is present. This attribute specifies the expiration date of the identification method used to identify the agent with Power of Attorney for the user.
**Allowable Values:**
- `chapter`
- `military_start_date`
- `end_date`
- `poa_details`
- `agent_name`
- `agent_address`
- `agent_id_type`
- `agent_id_value`
- `agent_id_expiration_date` |
| attributes\[].**value**
string
Conditionally returned | The value of the attribute.
**Allowable Values:**
- **chapter:**`CHAPTER_7`, `CHAPTER_11`, `CHAPTER_12`, `CHAPTER_13`
- **military\_start\_date:** yyyy-MM-ddThh:mm:ssZ format
- **end\_date:** yyyy-MM-ddThh:mm:ssZ format
- **poa\_details:** string (255 char max)
- **agent\_name:** string (255 char max)
- **agent\_address:** string (255 char max)
- **agent\_id\_type:**`SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE`
- **agent\_id\_value:** string (255 char max)
- **agent\_id\_expiration\_date:** yyyy-MM-ddThh:mm:ssZ format |
| created\_time
datetime
Conditionally returned | Date and time when the substatus 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 substatus was last updated on Marqeta’s credit platform, in UTC.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
| events
array of objects
Conditionally returned | List of events related to the substatus.
**Allowable Values:**
Valid array of one or more substatus events |
| events\[].**state**
string
Returned | The state of the event.
**Allowable Values:**
`ACTIVE`, `INACTIVE`, `DECEASED_REPORTED`, `DECEASED_CONFIRMED`, `FRAUD_REPORTED`, `FRAUD_CONFIRMED`, `BANKRUPTCY_FILED`, `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, `BANKRUPTCY_DISMISSED_INACTIVE` |
| events\[].**channel**
string
Returned | The channel through which the event occurred.
**Allowable Values:**
`ADMIN`, `API`, `FRAUD`, `SYSTEM` |
| events\[].**reason**
string
Conditionally returned | Reason for the event.
**Allowable Values:**
255 char max |
| events\[].**effective\_date**
datetime
Returned | Effective date of the event, in UTC.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
| events\[].**created\_time**
datetime
Returned | Creation time of the event.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
```json JSON expandable lines wrap theme={null}
{
"token": "substatus_token",
"resource_type": "USER",
"resource_token": "my_user_token",
"substatus": "SCRA",
"state": "ACTIVE",
"is_active": true,
"attributes": [
{
"key": "military_start_date",
"value": "2024-04-02T11:23:23Z"
}
],
"created_time": "2024-04-02T11:23:23Z",
"updated_time": "2024-04-02T11:23:23Z",
"events": [
{
"state": "ACTIVE",
"channel": "ADMIN",
"reason": "Documents submitted and verified",
"effective_date": "2024-04-02T11:23:23Z",
"created_time": "2024-04-02T11:23:23Z"
}
]
}
```
Update substatus
**Action:** `PUT`\
**Endpoint:** `/credit/substatuses/{substatus_token}`
Updating a substatus registers a new event that changes the substatus' state.
URL path parameters
| Fields | Description |
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| substatus\_token
string
Required | Unique identifier of the account substatus resource to retrieve.
Send a `GET` request to `/credit/substatuses` to retrieve existing substatus tokens.
**Allowable Values:**
Existing substatus token |
Request body
| Fields | Description |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| state
string
Required | New state of the substatus.
- `INACTIVE` is a valid state for substatuses `HARDSHIP`, `FRAUD`, `MLA`, `SCRA`, `DECEASED`, `BLOCKED`, `CEASE_AND_DESIST`, `OPT_OUT`, and `POWER_OF_ATTORNEY`.
- `DECEASED_CONFIRMED` is a valid state for substatus `DECEASED`.
- `FRAUD_CONFIRMED` is a valid state for substatus `FRAUD`.
- `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, and `BANKRUPTCY_DISMISSED_INACTIVE` states are applicable to `BANKRUPTCY`.
**Allowable Values:**
`INACTIVE`, `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, `BANKRUPTCY_DISMISSED_INACTIVE`, `DECEASED_CONFIRMED`, `FRAUD_CONFIRMED` |
| channel
string
Optional | The mechanism by which a state designation was applied to a substatus. If no value is set, then it defaults to `API`.
- `ADMIN` - Indicates that the state of the substatus was added through the Marqeta Dashboard.
- `API` - Indicates that you initiated the update of the substatus through the Core API. Use this value when creating a card transition with an API `POST` request.
- `FRAUD` - Indicates that either Marqeta or the card network has determined that the account is fraudulent.
- `SYSTEM` - Indicates that the substatus update was initiated by Marqeta. For example, Marqeta determined during application decisioning that the applicant is `MLA`.
**Allowable Values:**
`ADMIN`, `API`, `FRAUD`, `SYSTEM` |
| reason
string
Optional | Reason for applying the state to the substatus.
**Allowable Values:**
1–255 chars |
| effective\_date
datetime
Optional | Date and time when the state of the substatus is effective, in UTC.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
Sample request body
```json JSON lines wrap theme={null}
{
"state": "INACTIVE",
"channel": "ADMIN",
"reason": "Remove substatus from account",
"effective_date": "2024-04-09T11:23:23Z"
}
```
Response body
| Fields | Description |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token
string
Returned | Unique identifier of the credit substatus.
**Allowable Values:**
36 char max |
| resource\_type
string
Returned | Type of resource to which the substatus is applied.
**Allowable Values:**
`ACCOUNT`, `USER`, `BUSINESS` |
| resource\_token
string
Returned | Unique identifier of the resource.
**Allowable Values:**
36 char max |
| substatus
string
Returned | Type of substatus.
**Allowable Values:**
36 char max
- `HARDSHIP`
- `FRAUD`
- `MLA`
- `SCRA`
- `DECEASED`
- `BANKRUPTCY`
- `POWER_OF_ATTORNEY`
- `BLOCKED`
- `CEASE_AND_DESIST`
- `OPT_OUT` |
| state
string
Returned | Current state of the substatus.
**Allowable Values:**
`ACTIVE`, `INACTIVE`, `DECEASED_REPORTED`, `DECEASED_CONFIRMED`, `FRAUD_REPORTED`, `FRAUD_CONFIRMED`, `BANKRUPTCY_FILED`, `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, `BANKRUPTCY_DISMISSED_INACTIVE` |
| is\_active
boolean
Returned | Denotes whether a substatus is active.
**Allowable Values:**
`true`, `false` |
| attributes
array of objects
Conditionally returned | Additional dynamic attributes related to the substatus.
If the substatus is `BANKRUPTCY`, `SCRA`, or `POWER_OF_ATTORNEY`, then attributes are present.
**Allowable Values:**
`key`, `value` |
| attributes\[].**key**
string
Conditionally returned | The name of the attribute.
Marqeta provides several preconfigured attributes, as described in the following list.
- **chapter:** If the substatus is `BANKRUPTCY`, then this value defines the chapter.
- **military\_start\_date:** If the substatus is `SCRA`, then this value defines the military start date.
- **end\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the end date attribute is present. This specifies the date when the power of attorney document is no longer valid.
- **poa\_details:** If the substatus is `POWER_OF_ATTORNEY`, then the Power of Attorney details attribute is applicable. This attribute specifies the range of actions that the agent with Power of Attorney is able to perform on the account. By default the range is `UNRESTRICTED`.
- **agent\_name:** If the substatus is `POWER_OF_ATTORNEY`, then the agent name is present. This attribute specifies the name of the agent with Power of Attorney for the user.
- **agent\_address:** If the substatus is `POWER_OF_ATTORNEY`, then the agent address attribute is present. This attribute specifies the address of the agent with Power of Attorney for the user.
- **agent\_id\_type:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification type attribute is present. This specifies the type of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_value:** If the substatus is `POWER_OF_ATTORNEY`, then the agent identification value attribute is present. This attribute specifies the value of the identification method used to identify the agent with Power of Attorney for the user.
- **agent\_id\_expiration\_date:** If the substatus is `POWER_OF_ATTORNEY`, then the attribute for the Power of Attorney identification expiration date attribute is present. This attribute specifies the expiration date of the identification method used to identify the agent with Power of Attorney for the user.
**Allowable Values:**
- `chapter`
- `military_start_date`
- `end_date`
- `poa_details`
- `agent_name`
- `agent_address`
- `agent_id_type`
- `agent_id_value`
- `agent_id_expiration_date` |
| attributes\[].**value**
string
Conditionally returned | The value of the attribute.
**Allowable Values:**
- **chapter:**`CHAPTER_7`, `CHAPTER_11`, `CHAPTER_12`, `CHAPTER_13`
- **military\_start\_date:** yyyy-MM-ddThh:mm:ssZ format
- **end\_date:** yyyy-MM-ddThh:mm:ssZ format
- **poa\_details:** string (255 char max)
- **agent\_name:** string (255 char max)
- **agent\_address:** string (255 char max)
- **agent\_id\_type:**`SSN`, `TIN`, `SIN`, `NIN`, `PASSPORT_NUMBER`, `DRIVERS_LICENSE`, `BUSINESS_LICENSE`, `BUSINESS_NUMBER`, `BUSINESS_TAX_ID`, `TAXPAYER_REFERENCE`
- **agent\_id\_value:** string (255 char max)
- **agent\_id\_expiration\_date:** yyyy-MM-ddThh:mm:ssZ format |
| created\_time
datetime
Conditionally returned | Date and time when the substatus 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 substatus was last updated on Marqeta’s credit platform, in UTC.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
| events
array of objects
Conditionally returned | List of events related to the substatus.
**Allowable Values:**
Valid array of one or more substatus events |
| events\[].**state**
string
Returned | The state of the event.
**Allowable Values:**
`ACTIVE`, `INACTIVE`, `DECEASED_REPORTED`, `DECEASED_CONFIRMED`, `FRAUD_REPORTED`, `FRAUD_CONFIRMED`, `BANKRUPTCY_FILED`, `BANKRUPTCY_WITHDRAWN`, `BANKRUPTCY_REAFFIRMED`, `BANKRUPTCY_REAFFIRM_RESCINDED`, `BANKRUPTCY_DISCHARGED`, `BANKRUPTCY_DISMISSED`, `BANKRUPTCY_FILED_INACTIVE`, `BANKRUPTCY_WITHDRAWN_INACTIVE`, `BANKRUPTCY_REAFFIRMED_INACTIVE`, `BANKRUPTCY_REAFFIRM_RESCINDED_INACTIVE`, `BANKRUPTCY_DISCHARGED_INACTIVE`, `BANKRUPTCY_DISMISSED_INACTIVE` |
| events\[].**channel**
string
Returned | The channel through which the event occurred.
**Allowable Values:**
`ADMIN`, `API`, `FRAUD`, `SYSTEM` |
| events\[].**reason**
string
Conditionally returned | Reason for the event.
**Allowable Values:**
255 char max |
| events\[].**effective\_date**
datetime
Returned | Effective date of the event, in UTC.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
| events\[].**created\_time**
datetime
Returned | Creation time of the event.
**Allowable Values:**
Format: yyyy-MM-ddThh:mm:ssZ |
Sample response body
```json JSON expandable lines wrap theme={null}
{
"token": "substatus_token",
"resource_type": "ACCOUNT",
"resource_token": "my_account_token",
"substatus": "FRAUD",
"state": "INACTIVE",
"is_active": false,
"attributes": [],
"created_time": "2024-04-02T11:23:23Z",
"updated_time": "2024-04-02T11:23:23Z",
"events": [
{
"state": "ACTIVE",
"channel": "SYSTEM",
"reason": "Fraud system detected suspicious activity",
"effective_date": "2024-04-02T11:23:23Z",
"created_time": "2024-04-02T11:23:23Z"
},
{
"state": "INACTIVE",
"channel": "ADMIN",
"reason": "Verified non-fraud with cardholder",
"effective_date": "2024-04-02T11:23:23Z",
"created_time": "2024-04-02T11:23:23Z"
}
]
}
```
Resend credit event notification
**Action:** `POST`\
**Endpoint:** `/credit/webhooks/{event_type}/{resource_token}`
Resends a credit event notification to your webhook endpoint.
Although you send this request as a `POST`, all parameters are passed in the URL and the body is empty. The event notification is resent to your webhook endpoint and also returned in the response to this request.
For details on how to configure your webhook endpoint, see the About Webhooks [tutorial](/developer-guides/about-webhooks/#_tutorial). For the complete `/webhooks` endpoint reference, see [Webhooks](/core-api/webhooks/).
URL path parameters
| Fields | Description |
| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| event\_type
string
Required | Specifies the type of event you want to resend.
**Allowable Values:**
`ledgerentry`, `journalentry`, `accounttransition`, `accountstatement`, `paymenttransition`, `delinquencytransition`, `paymentreminders`, `substatus`, `accountsignupbonus` |
| resource\_token
string
Required | Unique identifier of the resource for which you want to resend a notification.
- Send a `GET` request to `/credit/accounts/{account_token}/journalentries` to retrieve existing journal entry tokens.
- Send a `GET` request to `/credit/accounts/{account_token}/ledgerentries` to retrieve existing ledger entry tokens.
- Send a `GET` request to `/accounts/{account_token}/accounttransitions` to retrieve existing account transition tokens.
- Send a `GET` request to `/credit/accounts/{account_token}/payments/{payment_token}` to retrieve existing payment transition tokens.
- Send a `GET` request to `/accounts/{account_token}/statements` to retrieve existing statement summary tokens.
- Send a `GET` request to `/accounts/{account_token}/delinquencystate/transitions` to retrieve existing delinquency state transition tokens.
- Send a `GET` request to `/accounts/{account_token}/statements/{statement_summary_token}/paymentreminders/{token}` to retrieve existing payment reminder tokens.
- Send a `GET` request to `/credit/substatuses` to retrieve existing substatus tokens.
- Send a `GET` request to `/credit/accounts` to retrieve existing credit account tokens and identify the specific account for the resend event.
**Allowable Values:**
Existing journal entry token, ledger entry token, account transition token, payment transition token, statement summary token, delinquency transition token, or substatus token |
Response body
| Fields | Description |
| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| unused
string
Conditionally returned | Event notification that was resent to your webhook endpoint.
**Allowable Values:**
Valid event notification |
Sample response body
The following code block shows a sample of a resent `creditaccounttransitions` event.
```json JSON lines wrap theme={null}
{
"token": "my_credit_account_transition_token1234",
"account_token": "my_credit_account_token1234",
"original_status": "UNACTIVATED",
"status": "ACTIVE",
"created_time": "2024-08-18T20:25:10.408Z"
}
```
The following code block shows a sample of a resent `creditaccountstatements` event.
```json JSON lines wrap theme={null}
{
"token": "my_credit_account_statement_token",
"account_token": "my_credit_account_token",
"opening_balance": 496.45,
"closing_balance": 506.41,
"credit_limit": 500,
"available_credit": 0,
"past_due_amount": 10,
"purchases": 0,
"interest": 4.96,
"fees": 15,
"credits": 0,
"payments": 10,
"days_in_billing_cycle": 31,
"cycle_type": "REVOLVING",
"opening_date": "2025-03-01T05:00:00.000Z",
"closing_date": "2025-04-01T03:59:59.999Z",
"created_time": "2023-08-18T22:04:31.261Z"
}
```
The following code block shows a sample of a resent `creditjournalentries` event.
```json JSON expandable lines wrap theme={null}
{
"token": "my_journal_entry_token1234",
"related_token": null,
"root_token": null,
"account_token": "my_credit_account_token1234",
"card_token": "my_credit_card_token1234",
"status": "PENDING",
"group": "PURCHASE",
"type": "authorization",
"id": "12345678",
"amount": 10,
"currency_code": "USD",
"memo": "Jane's Bakery",
"request_time": "2024-08-18T22:06:52.000Z",
"impact_time": "2024-08-18T22:07:21.422Z",
"created_time": "2024-08-18T22:07:21.422Z",
"dispute_token": null,
"detail_token": "my_detail_token1234",
"detail_object": {
"type": "authorization",
"state": "PENDING",
"identifier": "234",
"token": "my_detail_token1234",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"card_token": "my_credit_card_token1234",
"gpa": {
"currency_code": "USD",
"ledger_balance": 510.87,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 510.87,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10
}
}
},
"gpa_order": {
"token": "my_gpa_order_token1234",
"amount": 10,
"created_time": "2024-08-18T22:06:53Z",
"last_modified_time": "2024-08-18T22:06:53Z",
"transaction_token": "my_transaction_token1234",
"state": "PENDING",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 10,
"source": {
"type": "programgateway",
"token": "**********1ab2",
"active": true,
"name": "credit_backed_funding_source",
"is_default_account": false,
"created_time": "2024-10-14T17:26:35Z",
"last_modified_time": "2024-10-14T17:26:35Z"
},
"gateway_log": {
"order_number": "my_gateway_token12345",
"transaction_id": "my_transaction_id1234",
"message": "Approved or completed successfully",
"duration": 485,
"timed_out": false,
"response": {
"code": "200",
"data": {
"jit_funding": {
"token": "my_jit_funding_token1234",
"method": "pgfs.authorization",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"amount": 10
}
}
}
}
},
"funding_source_token": "**********1ab2",
"jit_funding": {
"token": "my_transaction_id1234",
"method": "pgfs.authorization",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"amount": 10
},
"user_token": "my_user_token",
"currency_code": "USD"
},
"duration": 837,
"created_time": "2024-08-18T22:06:52Z",
"user_transaction_time": "2024-08-18T22:06:52Z",
"settlement_date": "2024-08-18T00:00:00Z",
"request_amount": 10,
"amount": 10,
"currency_code": "USD",
"approval_code": "974406",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"network": "DISCOVER",
"acquirer_fee_amount": 0,
"acquirer": {
"system_trace_audit_number": "376582"
},
"user": {
"metadata": {
"key1": "value1",
"key2": "value2",
"notification_email": "user@domain.com",
"notification_language": "spa"
}
},
"card": {
"last_four": "9949",
"metadata": {}
},
"issuer_received_time": "2024-08-18T22:06:52.771Z",
"issuer_payment_node": "f8205a67b12b90d695b15704a64c074b",
"network_reference_id": "484311571095",
"card_acceptor": {
"mid": "1234",
"mcc": "6411",
"name": "Jane's Bakery",
"street_address": "1989 Fillmore St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94115",
"country_code": "USA"
},
"pos": {
"pin_present": false,
"partial_approval_capable": true,
"purchase_amount_only": false,
"is_recurring": false,
"is_installment": false
}
}
}
```
The following code block shows a sample of a resent `creditledgerentries` event.
```json JSON expandable lines wrap theme={null}
{
"token": "my_ledger_entry_token1234",
"related_token": null,
"root_token": null,
"account_token": "my_credit_account_token1234",
"card_token": "my_credit_card_token1234",
"status": "PENDING",
"group": "PURCHASE",
"type": "authorization",
"id": "12345678",
"amount": 10,
"currency_code": "USD",
"memo": "Jane's Bakery",
"request_time": "2024-08-18T22:06:52.000Z",
"impact_time": "2024-08-18T22:07:21.422Z",
"created_time": "2024-08-18T22:07:21.422Z",
"dispute_token": null,
"detail_token": "my_detail_token1234",
"detail_object": {
"type": "authorization",
"state": "PENDING",
"identifier": "234",
"token": "my_detail_token1234",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"card_token": "my_credit_card_token1234",
"gpa": {
"currency_code": "USD",
"ledger_balance": 510.87,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10,
"balances": {
"USD": {
"currency_code": "USD",
"ledger_balance": 510.87,
"available_balance": 0,
"credit_balance": 0,
"pending_credits": 0,
"impacted_amount": -10
}
}
},
"gpa_order": {
"token": "my_gpa_order_token1234",
"amount": 10,
"created_time": "2024-08-18T22:06:53Z",
"last_modified_time": "2024-08-18T22:06:53Z",
"transaction_token": "my_transaction_token1234",
"state": "PENDING",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"funding": {
"amount": 10,
"source": {
"type": "programgateway",
"token": "**********1ab2",
"active": true,
"name": "credit_backed_funding_source",
"is_default_account": false,
"created_time": "2024-10-14T17:26:35Z",
"last_modified_time": "2024-10-14T17:26:35Z"
},
"gateway_log": {
"order_number": "my_gateway_token12345",
"transaction_id": "my_transaction_id1234",
"message": "Approved or completed successfully",
"duration": 485,
"timed_out": false,
"response": {
"code": "200",
"data": {
"jit_funding": {
"token": "my_jit_funding_token1234",
"method": "pgfs.authorization",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"amount": 10
}
}
}
}
},
"funding_source_token": "**********1ab2",
"jit_funding": {
"token": "my_transaction_id1234",
"method": "pgfs.authorization",
"user_token": "my_user_token",
"acting_user_token": "my_user_token",
"amount": 10
},
"user_token": "my_user_token",
"currency_code": "USD"
},
"duration": 837,
"created_time": "2024-08-18T22:06:52Z",
"user_transaction_time": "2024-08-18T22:06:52Z",
"settlement_date": "2024-08-18T00:00:00Z",
"request_amount": 10,
"amount": 10,
"currency_code": "USD",
"approval_code": "974406",
"response": {
"code": "0000",
"memo": "Approved or completed successfully"
},
"network": "DISCOVER",
"acquirer_fee_amount": 0,
"acquirer": {
"system_trace_audit_number": "376582"
},
"user": {
"metadata": {
"key1": "value1",
"key2": "value2",
"notification_email": "user@domain.com",
"notification_language": "spa"
}
},
"card": {
"last_four": "9949",
"metadata": {}
},
"issuer_received_time": "2024-08-18T22:06:52.771Z",
"issuer_payment_node": "f8205a67b12b90d695b15704a64c074b",
"network_reference_id": "484311571095",
"card_acceptor": {
"mid": "1234",
"mcc": "6411",
"name": "Jane's Bakery",
"street_address": "1989 Fillmore St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94115",
"country_code": "USA"
},
"pos": {
"pin_present": false,
"partial_approval_capable": true,
"purchase_amount_only": false,
"is_recurring": false,
"is_installment": false
}
}
}
```
The following code block shows a sample of a resent `creditpaymenttransitions` event.
```json JSON lines wrap theme={null}
{
"token": "my_payment_transition_token1234",
"account_token": "my_credit_account_token1234",
"payment_token": "my_credit_account_payment_token1234",
"status": "COMPLETED",
"refund_details": null,
"created_time": "2024-08-17T18:26:47.591Z"
}
```
The following code block shows a sample of a resent `creditdelinquencytransitions` event.
```json JSON lines wrap theme={null}
{
"token": "my_delinquency_transition_token1234",
"account_token": "my_credit_account_token1234",
"transition_trigger_reason": "STATEMENT_GENERATION",
"transition_trigger_time": "2024-03-01 04:59:59.999",
"original_status": "CURRENT",
"status": "DELINQUENT",
"impact_time": "2024-03-01 04:59:59.999",
"total_past_due": 100,
"current_due": 40,
"total_due": 140,
"oldest_payment_due_date": "2023-02-01 04:59:59.999",
"bucket_count": 2,
"is_rolled_back": false,
"created_time": "2024-03-01 04:59:59.999",
"updated_time": "2024-03-01 04:59:59.999"
}
```
The following code block shows a sample of a resent `substatus` event.
```json JSON expandable lines wrap theme={null}
{
"token": "substatus_token",
"resource_type": "ACCOUNT",
"resource_token": "my_account_token",
"substatus": "FRAUD",
"state": "INACTIVE",
"is_active": false,
"attributes": [],
"created_time": "2024-04-02T11:23:23Z",
"updated_time": "2024-04-02T11:23:23Z",
"events": [
{
"state": "ACTIVE",
"channel": "SYSTEM",
"reason": "Fraud system detected suspicious activity",
"effective_date": "2024-04-02T11:23:23Z",
"created_time": "2024-04-02T11:23:23Z"
},
{
"state": "INACTIVE",
"channel": "ADMIN",
"reason": "Verified non-fraud with cardholder",
"effective_date": "2024-04-02T11:23:23Z",
"created_time": "2024-04-02T11:23:23Z"
}
]
}
```
The following code block shows a sample of a resent `accountsignupbonus` event.
```json JSON lines wrap theme={null}
{
"token": "my_accountsignupbonus_token",
"account_token": "my_account_token",
"type": "STATEMENT_CREDIT",
"status": "ISSUED",
"accrual_start_time": "2024-04-02T11:23:23Z",
"maturity_time": "2024-04-02T11:23:23Z",
"spend_total": 10,
"reward_token": "my_reward_token",
"journal_entry_token": "my_journal_entry_token"
}
```
## Related topics
- [2024 Release Notes](/docs/developer-guides/release-notes-2024.md)
- [Payments](/docs/core-api/credit-account-payments.md)
- [Delinquency](/docs/core-api/credit-account-delinquency.md)
- [Credit Accounts](/docs/core-api/credit-accounts.md)
- [About Credit Accounts](/docs/developer-guides/about-credit-accounts.md)