Account application created
This event occurs when the platform creates an account application. In addition to the application ID that is available on the account application prospect, this event includes created account ID, entity ID, and customer ID.
Generated by: Create account application with the submit
property set to true
More information: Create or update account
Type: object
Domain: onboarding
Event: succeeded
Version: 1
acquisitionChannel
Title: Onboarding acquisition channel. A program has many Acquisition Channel, generally used to identify by where users was registered.
Type: integer
dueDate
Title: Due date ID. Used to identify choose date by client.
Type: integer
metadata
Title: This object returns what we receive from the onboarding request.
Type: object or null
program
Title: Program information.
Type: objectid required
Title: Program ID - Identifier
Type: integertype required
Title: Program type definitions.
Type: objectid required
Title: Program Type ID - Identifier
Type: integerdescription required
Title: Program Type description.
Type: string
Min length: 1
Max length: 30
Example:
CREDITO
PRE-PAGO
DEBITO
ALIMENTACAO
MERCHANT
CONTA-CORRENTE
pci required
Title: Is program type inside a PCI context?
Type: boolean
Min length: 1
Max length: 5
Example:
true
false
applicant
Type: object
documentNumber required
Description: The company or person document. E.g: In Brazil is CPF/CNPJ, only numbers
Type: string
Min length: 1
Max length: 15
Example:
03165757712
birthDate
Description: Birth date
Type: string or null
Min length: 0
Max length: 10personal
Title: The applicant's personal information
Type: objectexternalId
Description: A key defined by the client. It can have any format
Type: string or null
Example:
3d0ca315-aff9–4fc2-be61–3b76b9a2d798
name required
Type: string
Type: string
gender
Type: string or null
Must be one of the following:
M
F
printedName
Description: The name that must be printed in the card
Type: string or nullnickname
Type: string or null
socialName
Description: Social name, can be different of the document name
Type: string or nullalias
Description: The alias for the account
Type: string or nullcountryOfBirth
Type: string or null
Example:
Brazil
cityOfBirth
Type: string or null
Example:
Campo Belo
stateOfBirth
Type: string or null
educationDegree
Type: string or null
maritalStatus
Type: string or null
Example:
SINGLE
MARRIED
dependants
Description: The number of dependants
Type: string or nullfathersName
Type: string or null
mothersName
Type: string or null
nationality
Type: string or null
otherIdNumber
Description: Another document id. E.g. Driver license number
Type: string or nulldocumentType
Description: The otherIdNumber document type. E.g. Drive license
Type: string or nulldocumentIssuedBy
Type: string or null
Example:
SSP
PC
documentIssuedAt
Description: Where the document was issued
Type: string or null
Example:
RJ
SP
documentIssuedDate
Type: string or null
occupation
Description: Person job
Type: string or nullassets
Description: Person assets
Type: string or nullincome
Description: Person income
Type: string or nullnetWorth
Description: Person net worth
Type: string or nullpep
Description: Indicates if person is politically exposed
Type: string or null
Example:
true
false
statutory
Type: string or null
Example:
true
false
professional
Title: The applicant's professional information
Type: objectadmissionDate
Type: string or null
role
Type: string or null
occupation
Type: string
carrer
Type: string or null
career
Type: string or null
salary
Type: number
extraEarnings
Type: integer or null
extraEarningsSource
Type: string or null
previousEmployer
Type: string or null
previousAdmissionDate
Type: string or null
Format: datedocumentNumber
Type: string
company
Title: The applicant's company information
Type: objectexternalId
Description: A key defined by the client. It can have any format
Type: string or null
Example:
3d0ca315-aff9–4fc2-be61–3b76b9a2d798
name required
Description: The same as the document
Type: stringType: string or null
registrationNumber
Type: string or null
companyName
Description: Trading name
Type: string or nullactivity
Description: Company activity
Type: string or nullcompanyType
Type: string or null
Example:
S.A
LTDA
companyFormat
Description: It's related to the company classification
Type: string or null
Example:
ME
MEI
companyConstitutionDate
Type: string or null
occupation
Description: It also can be the company activity
Type: string or nullannualRevenues
Type: string or null
Example:
112312.12
type
Description: Always is 2
Type: string or nullnumberOfPartners
Type: string or null
Example:
1
2
percOwnership
Description: Percentual of ownership
Type: string or null
Example:
30
fiscalSituation
Description: Company fiscal situation
Type: string or nulldebt
Type: string or null
Example:
1800
income
Description: Company income
Type: string or null
Example:
112312.12
netWorth
Description: Company net worth
Type: string or null
Example:
112312.12
partner
Title: The company partner information. This is a metadata, so this object returns what we receive from the onboarding request
Type: ['object', 'null']partners
Title: List of partners
Type: arrayaddresses
Title: List of addresses
Type: array or nulladdressExternalId
Type: string or null
zipCode
Description: Zipcode. Depends on the region. E.g. In Brasil it's CEP
Type: string or nulladdress
Description: The street/avenue/etc name
Type: string or nullnumber
Description: The number of the address. Accepts only numbers
Type: string or nullneighborhood
Type: string or null
complementaryAddress
Type: string or null
city
Type: string
state
Type: string
Example:
SP
AC
RJ
country
Type: string or null
Example:
Brasil
addressType
Type: string
Example:
COMMERCIAL
OTHER
RESIDENTIAL
date
Description: Datetime of creation
Type: string or null
Example:
2018-06-30 17:25:57
mailingAddress
Description: Indicates if is the mailing address
Type: boolean or nullphones
Title: A list of phone numbers
Type: array or nullid
Description: Created id
Type: integerphoneType required
Description: Indicates the phone type
Type: string
Example:
MOBILE
RESIDENTIAL
COMMERCIAL
phone required
Type: string
Example:
999618921
areaCode
Description: Indicates the phone area code
Type: string or null
Example:
11
61
extension
Description: Phone's extension
Type: string or null
Example:
Ramal 32
custom_fields
Title: Custom fields
Description: CustomFields field with any key-value pairs.
Type: object or null
Example:{ "value_1": 800, "value_2": "17f43184-f1b5-4bac-9fba-49e2d178d1a4" }
customFields
Description: It's possible to insert any value
Type: object or null
Example:
Any value
entity required
Type: object
id required
Description: Entity id created
Type: integeraccount required
Title: The applicant's account options
Type: objectType: string or null
Min length: 0
Max length: 255exchangeMode required
Title: Wether any foreign transaction should be charged by the exchange rate at the day it occurred or at the statement's closing date
Type: string
Min length: 1
Max length: 8
Must be one of the following:
SAME_DAY
CLOSING
maxLimit required
Description: Account's max limit
Type: string
Min length: 1
Max length: 20limit required
Description: Account's limit
Type: string
Min length: 1
Max length: 20id required
Description: Created id
Type: integerpassword
Description: Empty field. Always is null
Type: string or nullcurrencyCode
Title: Currency code related to the account.
Type: string
Min length: 1
Max length: 3
Example:
BRL
currencyId
Title: Currency ID related to the currency.
Type: integertotalOverdraftLimit
Title: Account's total overdraft limit.
Type: string
Min length: 1
Max length: 20withdrawCreditLimit
Title: Account's total withdraw credit limit.
Type: string
Min length: 1
Max length: 20externalId
Description: A key defined by the client. It can have any format
Type: string or null
Min length: 0
Max length: 60
Example:
3d0ca315-aff9–4fc2-be61–3b76b9a2d798
accountStatus
Description: Current status of the account. Used for internal Pismo processing.
Type: string or null
Example:
BLOCKED
CANCELLED
NORMAL
STAND-BY
collectionStatus
Description: Financial status of the account. Used for internal Pismo processing.
Type: string or null
Example:
NORMAL
OVERDUE
STATEMENT_AGREEMENT
creationDate required
Description: Account creation timestamp.
Type: string
Format: date-time
Example:
2019-10-18T18:26:28.000Zdivision_id
Title: Account's administrative division ID
Type: integer
Example:
2856813card
Title: The applicant's card options
Type: objectpassword required
Type: string
token
Title: The Token Schema
Type: objectid required
Type: integer
token required
Type: string
Min length: 1
Max length: 255customer required
Title: The Customer Schema
Type: objectprintedName required
Description: The name that must be printed in the card
Type: string
Min length: 1
Max length: 25nickname required
Type: string
Min length: 1
Max length: 60socialName
Description: Person social name
Type: string or null
Min length: 0
Max length: 60sendPasswordToPhone
Description: Phone that will receive the password
Type: string or null
Min length: 0
Max length: 5
Example:
00 00000000000
id required
Description: Created id
Type: integerbankAccount
Title: Bank Account
Type: ['object', 'null']bank required
Title: Bank Code
Type: string
Example:
341
branch required
Title: Branch Code
Type: string
Example:
0500
id required
Description: Bank ID
Type: integer
Example:
30604
16864981
accountNumber required
Title: Account number
Type: string
Example:
000000001
checkDigit required
Title: Account number check digit
Type: string
Example:
8
accountType required
Title: Account type description
Type: string
Example:
Payment Account
interoperability required
Title: Account interoperability
Type: string
Example:
00000000000000000000
status required
Title: Account status
Type: string
Example:
ACTIVE
creationDate required
Title: The bank creation date
Type: string or null
Example:
2019-10-18T18:26:28+0000
lastUpdate
Title: The last update of bank
Type: string or null
Example:
2019-10-18T18:26:28+0000
currentBalance
Title: Current balance
Type: number or null
Example:
100.84
null
accountId required
Title: Account ID of the source holder
Type: integer or null
Example:
540
programId required
Title: Program ID of the source holder
Type: integer
Example:
540
additionals
Type: array or null
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://pismo.io/events/account/acquisition-onboarding.json",
"type": "object",
"title": "Account application created",
"description": "This event occurs when the platform creates an account application. In addition to the application ID that is available on the account application prospect, this event includes created account ID, entity ID, and customer ID. <br>Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/post-acquisitions-v3-s2s-applications' target='_blank'>Create account application</a> with the `submit` property set to `true` <br>More information: <a href='https://developers.pismo.io/pismo-docs/docs/create-an-account' target='_blank'>Create or update account</a>",
"required": [],
"properties": {
"acquisitionChannel": {
"title": "Onboarding acquisition channel. A program has many Acquisition Channel, generally used to identify by where users was registered.",
"type": "integer",
"minimum": 1,
"maximum": 4294967295
},
"dueDate": {
"title": "Due date ID. Used to identify choose date by client.",
"type": "integer",
"minimum": 1,
"maximum": 4294967295
},
"metadata": {
"type": [
"object",
"null"
],
"title": "This object returns what we receive from the onboarding request."
},
"program": {
"type": "object",
"title": "Program information.",
"required": [
"id",
"type"
],
"properties": {
"id": {
"title": "Program ID - Identifier",
"type": "integer",
"minimum": 1,
"maximum": 4294967295
},
"type": {
"type": "object",
"title": "Program type definitions.",
"required": [
"id",
"description",
"pci"
],
"properties": {
"id": {
"title": "Program Type ID - Identifier",
"type": "integer",
"minimum": 1,
"maximum": 4294967295
},
"description": {
"title": "Program Type description.",
"type": "string",
"minLength": 1,
"maxLength": 30,
"examples": [
"CREDITO",
"PRE-PAGO",
"DEBITO",
"ALIMENTACAO",
"MERCHANT",
"CONTA-CORRENTE"
]
},
"pci": {
"title": "Is program type inside a PCI context?",
"type": "boolean",
"minLength": 1,
"maxLength": 5,
"examples": [
true,
false
]
}
}
}
}
},
"applicant": {
"type": "object",
"required": [
"documentNumber",
"entity",
"account",
"customer"
],
"properties": {
"documentNumber": {
"description": "The company or person document. E.g: In Brazil is CPF/CNPJ, only numbers",
"type": "string",
"minLength": 1,
"maxLength": 15,
"examples": [
"03165757712"
]
},
"birthDate": {
"description": "Birth date",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 10,
"pattern": "^([0-2][0-9]|(3)[0-1])(/)(((0)[0-9])|((1)[0-2]))(/)\\d{4}$"
},
"personal": {
"$ref": "#/definitions/personal"
},
"professional": {
"$ref": "#/definitions/professional"
},
"company": {
"$ref": "#/definitions/company"
},
"addresses": {
"type": [
"array",
"null"
],
"title": "List of addresses",
"items": {
"$ref": "#/definitions/address"
}
},
"customFields": {
"type": [
"object",
"null"
],
"description": "It's possible to insert any value",
"examples": [
"Any value"
]
},
"entity": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"description": "Entity id created",
"type": "integer",
"minimum": 1,
"maximum": 4294967295
}
}
},
"account": {
"$ref": "#/definitions/account"
},
"card": {
"$ref": "#/definitions/card"
},
"token": {
"type": "object",
"title": "The Token Schema",
"required": [
"id",
"token"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 4294967295
},
"token": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
},
"customer": {
"$ref": "#/definitions/customer"
},
"bankAccount": {
"$ref": "#/definitions/bankaccount"
},
"additionals": {
"type": [
"array",
"null"
]
}
}
}
},
"definitions": {
"bankaccount": {
"type": [
"object",
"null"
],
"title": "Bank Account",
"required": [
"accountId",
"bank",
"branch",
"id",
"accountNumber",
"checkDigit",
"accountType",
"interoperability",
"status",
"creationDate",
"programId"
],
"properties": {
"bank": {
"type": "string",
"title": "Bank Code",
"examples": [
"341"
]
},
"branch": {
"type": "string",
"title": "Branch Code",
"examples": [
"0500"
]
},
"id": {
"type": "integer",
"description": "Bank ID",
"examples": [
"30604",
"16864981"
]
},
"accountNumber": {
"type": "string",
"title": "Account number",
"examples": [
"000000001"
]
},
"checkDigit": {
"type": "string",
"title": "Account number check digit",
"examples": [
"8"
]
},
"accountType": {
"type": "string",
"title": "Account type description",
"examples": [
"Payment Account"
]
},
"interoperability": {
"type": "string",
"title": "Account interoperability",
"examples": [
"00000000000000000000"
]
},
"status": {
"type": "string",
"title": "Account status",
"examples": [
"ACTIVE"
]
},
"creationDate": {
"type": [
"string",
"null"
],
"title": "The bank creation date",
"examples": [
"2019-10-18T18:26:28+0000"
]
},
"lastUpdate": {
"type": [
"string",
"null"
],
"title": "The last update of bank",
"examples": [
"2019-10-18T18:26:28+0000"
]
},
"currentBalance": {
"type": [
"number",
"null"
],
"title": "Current balance",
"examples": [
100.84,
0
]
},
"accountId": {
"type": [
"integer",
"null"
],
"title": "Account ID of the source holder",
"examples": [
540
]
},
"programId": {
"type": "integer",
"title": "Program ID of the source holder",
"examples": [
540
]
}
}
},
"personal": {
"type": "object",
"title": "The applicant's personal information",
"required": [
"name"
],
"properties": {
"externalId": {
"type": [
"string",
"null"
],
"description": "A key defined by the client. It can have any format",
"examples": [
"3d0ca315-aff9\u20134fc2-be61\u20133b76b9a2d798"
]
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"gender": {
"type": [
"string",
"null"
],
"enum": [
"M",
"F"
]
},
"printedName": {
"type": [
"string",
"null"
],
"description": "The name that must be printed in the card"
},
"nickname": {
"type": [
"string",
"null"
]
},
"socialName": {
"type": [
"string",
"null"
],
"description": "Social name, can be different of the document name"
},
"alias": {
"type": [
"string",
"null"
],
"description": "The alias for the account"
},
"countryOfBirth": {
"type": [
"string",
"null"
],
"examples": [
"Brazil"
]
},
"cityOfBirth": {
"type": [
"string",
"null"
],
"examples": [
"Campo Belo"
]
},
"stateOfBirth": {
"type": [
"string",
"null"
]
},
"educationDegree": {
"type": [
"string",
"null"
]
},
"maritalStatus": {
"type": [
"string",
"null"
],
"examples": [
"SINGLE",
"MARRIED"
]
},
"dependants": {
"type": [
"string",
"null"
],
"description": "The number of dependants",
"pattern": "\\d{1,}"
},
"fathersName": {
"type": [
"string",
"null"
]
},
"mothersName": {
"type": [
"string",
"null"
]
},
"nationality": {
"type": [
"string",
"null"
]
},
"otherIdNumber": {
"type": [
"string",
"null"
],
"description": "Another document id. E.g. Driver license number"
},
"documentType": {
"type": [
"string",
"null"
],
"description": "The otherIdNumber document type. E.g. Drive license"
},
"documentIssuedBy": {
"type": [
"string",
"null"
],
"examples": [
"SSP",
"PC"
]
},
"documentIssuedAt": {
"type": [
"string",
"null"
],
"description": "Where the document was issued",
"examples": [
"RJ",
"SP"
]
},
"documentIssuedDate": {
"type": [
"string",
"null"
],
"pattern": "^([0-2][0-9]|(3)[0-1])(/)(((0)[0-9])|((1)[0-2]))(/)\\d{4}$"
},
"occupation": {
"type": [
"string",
"null"
],
"description": "Person job"
},
"assets": {
"type": [
"string",
"null"
],
"description": "Person assets"
},
"income": {
"type": [
"string",
"null"
],
"description": "Person income"
},
"netWorth": {
"type": [
"string",
"null"
],
"description": "Person net worth"
},
"pep": {
"type": [
"string",
"null"
],
"description": "Indicates if person is politically exposed",
"examples": [
"true",
"false"
]
},
"statutory": {
"type": [
"string",
"null"
],
"examples": [
"true",
"false"
]
}
}
},
"partner": {
"type": [
"object",
"null"
],
"title": "The company partner information. This is a metadata, so this object returns what we receive from the onboarding request"
},
"company": {
"type": "object",
"title": "The applicant's company information",
"required": [
"name"
],
"properties": {
"externalId": {
"type": [
"string",
"null"
],
"description": "A key defined by the client. It can have any format",
"examples": [
"3d0ca315-aff9\u20134fc2-be61\u20133b76b9a2d798"
]
},
"name": {
"type": "string",
"description": "The same as the document"
},
"email": {
"type": [
"string",
"null"
]
},
"registrationNumber": {
"type": [
"string",
"null"
]
},
"companyName": {
"type": [
"string",
"null"
],
"description": "Trading name"
},
"activity": {
"type": [
"string",
"null"
],
"description": "Company activity"
},
"companyType": {
"type": [
"string",
"null"
],
"examples": [
"S.A",
"LTDA"
]
},
"companyFormat": {
"type": [
"string",
"null"
],
"description": "It's related to the company classification",
"examples": [
"ME",
"MEI"
]
},
"companyConstitutionDate": {
"type": [
"string",
"null"
],
"pattern": "^([0-2][0-9]|(3)[0-1])(/)(((0)[0-9])|((1)[0-2]))(/)\\d{4}$"
},
"occupation": {
"type": [
"string",
"null"
],
"description": "It also can be the company activity"
},
"annualRevenues": {
"type": [
"string",
"null"
],
"examples": [
"112312.12"
]
},
"type": {
"type": [
"string",
"null"
],
"description": "Always is 2"
},
"numberOfPartners": {
"type": [
"string",
"null"
],
"examples": [
"1",
"2"
]
},
"percOwnership": {
"type": [
"string",
"null"
],
"description": "Percentual of ownership",
"examples": [
"30"
]
},
"fiscalSituation": {
"type": [
"string",
"null"
],
"description": "Company fiscal situation"
},
"debt": {
"type": [
"string",
"null"
],
"examples": [
"1800"
]
},
"income": {
"type": [
"string",
"null"
],
"description": "Company income",
"examples": [
"112312.12"
]
},
"netWorth": {
"type": [
"string",
"null"
],
"description": "Company net worth",
"examples": [
"112312.12"
]
},
"partner": {
"$ref": "#/definitions/partner"
},
"partners": {
"type": "array",
"title": "List of partners",
"items": {
"$ref": "#/definitions/partner"
}
}
}
},
"professional": {
"type": "object",
"title": "The applicant's professional information",
"properties": {
"admissionDate": {
"type": [
"string",
"null"
]
},
"role": {
"type": [
"string",
"null"
]
},
"occupation": {
"type": "string"
},
"carrer": {
"type": [
"string",
"null"
]
},
"career": {
"type": [
"string",
"null"
]
},
"salary": {
"type": "number"
},
"extraEarnings": {
"type": [
"integer",
"null"
]
},
"extraEarningsSource": {
"type": [
"string",
"null"
]
},
"previousEmployer": {
"type": [
"string",
"null"
]
},
"previousAdmissionDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"documentNumber": {
"type": "string"
}
}
},
"address": {
"type": "object",
"title": "Address",
"required": [],
"properties": {
"addressExternalId": {
"type": [
"string",
"null"
]
},
"zipCode": {
"type": [
"string",
"null"
],
"description": "Zipcode. Depends on the region. E.g. In Brasil it's CEP"
},
"address": {
"type": [
"string",
"null"
],
"description": "The street/avenue/etc name"
},
"number": {
"type": [
"string",
"null"
],
"description": "The number of the address. Accepts only numbers"
},
"neighborhood": {
"type": [
"string",
"null"
]
},
"complementaryAddress": {
"type": [
"string",
"null"
]
},
"city": {
"type": "string"
},
"state": {
"type": "string",
"examples": [
"SP",
"AC",
"RJ"
]
},
"country": {
"type": [
"string",
"null"
],
"examples": [
"Brasil"
]
},
"addressType": {
"type": "string",
"examples": [
"COMMERCIAL",
"OTHER",
"RESIDENTIAL"
]
},
"date": {
"type": [
"string",
"null"
],
"description": "Datetime of creation",
"examples": [
"2018-06-30 17:25:57"
]
},
"mailingAddress": {
"type": [
"boolean",
"null"
],
"description": "Indicates if is the mailing address"
},
"phones": {
"type": [
"array",
"null"
],
"title": "A list of phone numbers",
"items": {
"$ref": "#/definitions/phone"
}
},
"custom_fields": {
"type": [
"object",
"null"
],
"title": "Custom fields",
"description": "CustomFields field with any key-value pairs.",
"examples": [
{
"value_1": 800,
"value_2": "17f43184-f1b5-4bac-9fba-49e2d178d1a4"
}
]
}
}
},
"phone": {
"type": "object",
"title": "Phone item",
"required": [
"phoneType",
"phone"
],
"properties": {
"id": {
"description": "Created id",
"type": "integer",
"minimum": 1,
"maximum": 4294967295
},
"phoneType": {
"type": "string",
"description": "Indicates the phone type",
"examples": [
"MOBILE",
"RESIDENTIAL",
"COMMERCIAL"
]
},
"phone": {
"type": "string",
"examples": [
"999618921"
]
},
"areaCode": {
"type": [
"string",
"null"
],
"description": "Indicates the phone area code",
"examples": [
"11",
"61"
]
},
"extension": {
"type": [
"string",
"null"
],
"description": "Phone's extension",
"examples": [
"Ramal 32"
]
}
}
},
"account": {
"type": "object",
"title": "The applicant's account options",
"required": [
"exchangeMode",
"maxLimit",
"limit",
"id",
"creationDate"
],
"properties": {
"email": {
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 255
},
"exchangeMode": {
"title": "Wether any foreign transaction should be charged by the exchange rate at the day it occurred or at the statement's closing date",
"type": "string",
"enum": [
"SAME_DAY",
"CLOSING"
],
"minLength": 1,
"maxLength": 8
},
"maxLimit": {
"description": "Account's max limit",
"type": "string",
"minLength": 1,
"maxLength": 20
},
"limit": {
"description": "Account's limit",
"type": "string",
"minLength": 1,
"maxLength": 20
},
"id": {
"description": "Created id",
"type": "integer",
"minimum": 1,
"maximum": 4294967295
},
"password": {
"type": [
"string",
"null"
],
"description": "Empty field. Always is null"
},
"currencyCode": {
"title": "Currency code related to the account.",
"type": "string",
"minLength": 1,
"maxLength": 3,
"examples": [
"BRL"
]
},
"currencyId": {
"title": "Currency ID related to the currency.",
"type": "integer",
"minimum": 1,
"maximum": 4294967295
},
"totalOverdraftLimit": {
"title": "Account's total overdraft limit.",
"type": "string",
"minLength": 1,
"maxLength": 20
},
"withdrawCreditLimit": {
"title": "Account's total withdraw credit limit.",
"type": "string",
"minLength": 1,
"maxLength": 20
},
"externalId": {
"description": "A key defined by the client. It can have any format",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 60,
"examples": [
"3d0ca315-aff9\u20134fc2-be61\u20133b76b9a2d798"
]
},
"accountStatus": {
"type": [
"string",
"null"
],
"description": "Current status of the account. Used for internal Pismo processing.",
"examples": [
"BLOCKED",
"CANCELLED",
"NORMAL",
"STAND-BY"
]
},
"collectionStatus": {
"type": [
"string",
"null"
],
"description": "Financial status of the account. Used for internal Pismo processing.",
"examples": [
"NORMAL",
"OVERDUE",
"STATEMENT_AGREEMENT"
]
},
"creationDate": {
"type": "string",
"description": "Account creation timestamp.",
"format": "date-time",
"example": "2019-10-18T18:26:28.000Z"
},
"division_id": {
"type": "integer",
"title": "Account's administrative division ID",
"example": 2856813
}
}
},
"customer": {
"type": "object",
"title": "The Customer Schema",
"required": [
"printedName",
"nickname",
"id"
],
"properties": {
"printedName": {
"description": "The name that must be printed in the card",
"type": "string",
"minLength": 1,
"maxLength": 25
},
"nickname": {
"type": "string",
"minLength": 1,
"maxLength": 60
},
"socialName": {
"description": "Person social name",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 60
},
"sendPasswordToPhone": {
"description": "Phone that will receive the password",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 5,
"examples": [
"00 00000000000"
]
},
"id": {
"description": "Created id",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617
}
}
},
"card": {
"type": "object",
"title": "The applicant's card options",
"required": [
"password"
],
"properties": {
"password": {
"type": "string"
}
}
}
}
}
Updated 7 days ago