Corporate account created
This event occurs when a new corporate account is created.
Generated by: Create corporate account.
| More information: Creating a corporate account
Type: object
Domain: corporate
Event: corporate_account_creation
Version: 1
account_id required
Title: Account ID
Description: Unique ID associated with the Pismo account. This field is used to retrieve the account in the Pismo platform APIs.
Type: integer
Example:
100602614
division_id required
Title: Division ID
Description: Unique ID used to identify the division in the Pismo platform APIs.
Type: string
Max length: 36
Example:
1d22e668-a857-4455-aee7-dbe888f4bf2b
division_code required
Title: Division Code
Description: Unique code string that uniquely identifies the division within your organization.
Type: string
Max length: 36
Example:
division-code-123
program_id required
Title: Program ID
Description: Unique ID used to identify the program in the Pismo platform APIs.
Type: integer
Example:
20
applicant required
Type: object
document_number required
Title: Document number
Description: Document number to identify the account holder. The value for this field is usually a government-issued tax ID number.
Type: string
Example:
03165757712
name required
Title: Name
Description: Person's or company's name.
Type: string
Example:
Company name
external_id
Title: External ID
Description: Custom entity ID string that uniquely identifies the entity within your organization.
Type: string or null
Example:
df8d5b61-3cc0-4ec1-a72d-61860bff8fed
custom_fields
Title: Custom fields
Description: Metadata field with any key-value pairs.
Type: object or null
Example:{ "custom_info": "value" }
parent_account_id
Title: Parent account ID
Description: Unique ID of the associated parent account.
Type: integer or null
Example:
20
overdraft_limit required
Title: Overdraft limit
Description: Overdraft limit for the current account.
Type: number
Example:
100.0
target_balance
Title: Target balance
Description: Target balance for the current account.
Type: number or null
Example:
100.0
external_account_id
Title: External Account ID
Description: Custom account ID string that uniquely identifies the account within your organization. This field is a key that links a Pismo account to your account ID.
Type: string or null
Example:
df8d5b61-3cc0-4ec1-a72d-61860bff8fed
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Corporate account created",
"description": "This event occurs when a new corporate account is created. \n Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/post-account' target='_blank'>Create corporate account</a>. \n | More information: <a href='https://developers.pismo.io/pismo-docs/docs/creating-a-corporate-account-beta' target='_blank'>Creating a corporate account</a>",
"required": [
"account_id",
"division_id",
"division_code",
"program_id",
"applicant",
"overdraft_limit"
],
"properties": {
"account_id": {
"type": "integer",
"title": "Account ID",
"description": "Unique ID associated with the Pismo account. This field is used to retrieve the account in the Pismo platform APIs.",
"examples": [
100602614
]
},
"division_id": {
"type": "string",
"title": "Division ID",
"description": "Unique ID used to identify the division in the Pismo platform APIs.",
"maxLength": 36,
"examples": [
"1d22e668-a857-4455-aee7-dbe888f4bf2b"
]
},
"division_code": {
"type": "string",
"title": "Division Code",
"description": "Unique code string that uniquely identifies the division within your organization.",
"maxLength": 36,
"examples": [
"division-code-123"
]
},
"program_id": {
"type": "integer",
"title": "Program ID",
"description": "Unique ID used to identify the program in the Pismo platform APIs.",
"examples": [
20
]
},
"applicant": {
"$ref": "#/definitions/applicant"
},
"parent_account_id": {
"type": [
"integer",
"null"
],
"title": "Parent account ID",
"description": "Unique ID of the associated parent account.",
"examples": [
20
]
},
"overdraft_limit": {
"type": [
"number"
],
"title": "Overdraft limit",
"description": "Overdraft limit for the current account.",
"examples": [
100.0
]
},
"target_balance": {
"type": [
"number",
"null"
],
"title": "Target balance",
"description": "Target balance for the current account.",
"examples": [
100.0
]
},
"external_account_id": {
"type": [
"string",
"null"
],
"title": "External Account ID",
"description": "Custom account ID string that uniquely identifies the account within your organization. This field is a key that links a Pismo account to your account ID.",
"examples": [
"df8d5b61-3cc0-4ec1-a72d-61860bff8fed"
]
}
},
"definitions": {
"applicant": {
"type": "object",
"required": [
"document_number",
"name"
],
"properties": {
"document_number": {
"type": [
"string"
],
"title": "Document number",
"description": "Document number to identify the account holder. The value for this field is usually a government-issued tax ID number.",
"examples": [
"03165757712"
]
},
"name": {
"type": [
"string"
],
"title": "Name",
"description": "Person's or company's name.",
"examples": [
"Company name"
]
},
"external_id": {
"type": [
"string",
"null"
],
"title": "External ID",
"description": "Custom entity ID string that uniquely identifies the entity within your organization.",
"examples": [
"df8d5b61-3cc0-4ec1-a72d-61860bff8fed"
]
},
"custom_fields": {
"type": [
"object",
"null"
],
"title": "Custom fields",
"description": "Metadata field with any key-value pairs.",
"examples": [
{
"custom_info": "value"
}
]
}
}
}
}
}
{
"account_id": 100602614,
"division_id": "1d22e668-a857-4455-aee7-dbe888f4bf2b",
"division_code": "division-code-123",
"program_id": 20,
"applicant": {
"document_number": "03165757712",
"name": "Company name",
"external_id": "df8d5b61-3cc0-4ec1-a72d-61860bff8fed",
"custom_fields": {
"custom_info": "value"
}
},
"parent_account_id": 20,
"overdraft_limit": 100.0,
"target_balance": 100.0,
"external_account_id": "df8d5b61-3cc0-4ec1-a72d-61860bff8fed"
}
Updated 4 days ago