Bank slip registered
Type: object
Additional properties: false
Domain: bank-slip
Event: registered-bank-slip
Version: 1
registry_type required
Title: register type
Description: Identifies the type of the registration
Type: integer
Example:
1
charge_type required
Title: charge type
Description: Identifies the type of the charge
Type: integer
Example:
1
product_type required
Title: product type
Description: Identifies the type of the product
Type: string
Example:
00006
subproduct required
Title: subproduct
Description: Subproduct reference code
Type: string
Example:
00008
accepted_bankslip required
Title: accepted bank slip
Description: Flag to identifies if a bank slip accepts titleship
Type: string
Example:
N
S
bankslip_wallet required
Title: kind of bank slip wallet
Description: Identifies the type of the wallet
Type: number
Example:
175
our_number required
Title: our number
Description: Itau's account number
Type: string
Example:
00013840
our_number_check_number required
Title: our number check digit
Type: string
Example:
3
7
bar_code required
Title: bar code
Description: Bank slip bar code
Type: string
Example:
34191798200000189331750001384032525048415000
due_date required
Title: due date
Description: Bank slip due date
Type: string
Format: date
Example:
2019-08-15
bankslip_type required
Title: bank slip type
Description: Identifies the type of bank slip
Type: string
Example:
SELF
THIRD_PARTY
issue_date required
Title: issue date
Description: Bank slip issue date
Type: string
Example:
2019-08-15
payment_type required
Description: Identifies the type of payment
Type: integer
Example:
3
allow_partial_payment
Title: allow partial payment
Description: Flag to identifies if the bank slip accept partial payment
Example:
false
true
null
digitable_line_number required
Title: digitable line number
Description: Bar code with out the formating
Type: string
Example:
34191750090138403252850484150003179820000018933
payment_place required
Title: payment place
Description: Identifies the type of payment
Type: string
Example:
ATE O VENCIMENTO PAGUE EM QUALQUER BANCO OU CORRESPONDENTE NAO BANCARIO. APOS O VENCIMENTO, ACESSE ITAU.COM.BR/BOLETOS E PAGUE EM QUALQUER BANCO OU CORRESPONDENTE NAO BANCARIO.
processing_date required
Title: processing date
Description: The issue date of the bank slip
Type: string
Example:
2019-08-15
bankslip_amount required
Title: bankslip amount
Description: The amount of the bank slip
Type: number
Example:
189.33
discount_amount required
Title: discount amount
Description: The discount amount to be subtracted from the bankslip_amount
Type: number
Example:
null
other_deductions_amount required
Title: other deductions amount
Description: The amount of any other deductions
Type: number
Example:
null
interest_and_penalties_amount required
Title: interest and penalties amount
Description: The sum of all interests and penalties charged in the bank slip
Type: number
Example:
null
other_amount required
Title: other amount
Description: The sum of all values external taxes charged in the bank slip
Type: number
Example:
null
total_amount_charged required
Title: total amount charged
Description: The total amount charged in the bank slip
Type: number
Example:
null
interest_type
Title: interest type
Description: Identifies the type of interest
Type: number
Example:
5
penalties_type
Title: penalties type
Description: Identifies the type of penalties
Type: number
Example:
3
discount_type
Title: discount type
Description: Identifies the type of discount
Type: number
Example:
null
receipt_authorization_type
Title: receipt authorization type
Description: Identifies the type of discount
Type: string
Example:
3
account_id
Title: Account id
Description: Pismo's account identifier from bank slip owner
Type: number
Example:
1
578
100012777
program_id
Title: Program id
Description: Program identifier under which the account of the bank-slip owner was created
Type: number
Example:
1
578
100012777
limit_date
Title: Limit date
Description: Limit date for payment.
Type: string
Format: date
Example:
2019-08-15
payer required
Title: Payer
Description: Payer informations
Type: objectcpf_cnpj_payer
Title: cpf cnpj payer
Description: Payer document number. Ex: In Brazil is CPF/CNPJ, only numbers
Type: string or null
Example:
00021100080
43416178000120payer_name required
Title: payer name
Description: The name of the payer
Type: string
Example:
GABRIEL ANTONIO FORTEpayer_address required
Title: payer address
Description: The address of the payer
Type: string
Example:
ENDERECO DO CLIENTE, 000payer_neighborhood
Title: payer neighborhood
Description: The neighborhood of the payer
Type: string
Example:
BAIRROpayer_city required
Title: payer city
Description: The city of the payer
Type: string
Example:
São Paulopayer_state required
Title: payer state
Description: The UF/State/province of the payer
Type: string
Example:
SPpayer_cep required
Title: payer postal code
Description: The postal code of the payer
Type: string
Example:
03720030
guarantor required
Title: Guarantor
Description: Guarantor informations
Type: objectcpf_cnpj_guarantor
Title: guarantor document number
Description: Guarantor document number. Ex: In Brazil is CPF/CNPJ, only numbers
Type: string
Example:
00021100080
43416178000120guarantor_name required
Title: guarantor name
Description: The name of the guarantor
Type: string
Example:
GABRIEL ANTONIO FORTEguarantor_address required
Title: guarantor address
Description: The address guarantor
Type: string
Example:
ENDERECO DO CLIENTE, 000guarantor_neighborhood
Title: guarantor neighborhood
Description: The neighborhood guarantor
Type: string
Example:
BAIRROguarantor_city required
Title: guarantor city
Description: The city guarantor
Type: string
Example:
São Pauloguarantor_uf
Title: guarantor uf
Description: The UF/State/province of the guarantor
Type: string
Example:
SPguarantor_cep required
Title: guarantor postal code
Description: The postal code of the guarantor
Type: string
Example:
03390010
beneficiary
Title: Beneficiary
Description: Beneficiary informations
Type: objectbeneficiary_bank required
Title: beneficiary bank
Description: The bank code of the beneficiary
Type: string
Example:
341beneficiary_bank_check_digit required
Title: beneficiary bank check digit
Description: The bank digit of the beneficiary
Type: string
Example:
7beneficiary_agency required
Title: beneficiary agency
Description: The bank agency of the beneficiary
Type: string
Example:
2525beneficiary_accout required
Title: beneficiary account
Description: The bank account of the beneficiary
Type: string
Example:
04841beneficiary_account_check_digit required
Title: beneficiary account check digit
Description: The bank account check digit of the beneficiary
Type: string
Example:
5beneficiary_cpf_cnpj
Title: beneficiary document number
Description: Beneficiary document number. Ex: In Brazil is CPF/CNPJ, only numbers
Type: string
Example:
17192451000170corporate_name_beneficiary
Title: beeficiary corporate name
Description: The corporate name of the beneficiary
Type: string
Example:
ITAUCARD FIN S CRED FINANC INV
currency required
Title: currency
Description: Currency informations
Type: objectcurrency_code_cnab required
Title: currency cnab code
Description: The original currency code of the operation
Type: string
Example:
09currency_amount required
Title: currency amount
Description: The original currency amount of the operation
Type: number
Example:
nullcurrency_price required
Title: currency exchange price
Description: The exchange price of the operation
Type: number
Example:
null
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://pismo.io/events/bank-slip/registered-bank-slip.json",
"type": "object",
"title": "Bank slip registered",
"additionalProperties": false,
"required": [
"registry_type",
"charge_type",
"product_type",
"accepted_bankslip",
"subproduct",
"bankslip_wallet",
"our_number",
"our_number_check_number",
"bar_code",
"due_date",
"bankslip_type",
"issue_date",
"payment_type",
"digitable_line_number",
"payment_place",
"processing_date",
"bankslip_amount",
"discount_amount",
"other_deductions_amount",
"interest_and_penalties_amount",
"other_amount",
"total_amount_charged",
"payer",
"guarantor",
"beneficiary"
],
"properties": {
"registry_type": {
"type": "integer",
"title": "register type",
"description": "Identifies the type of the registration",
"examples": [
1
]
},
"charge_type": {
"type": "integer",
"title": "charge type",
"description": "Identifies the type of the charge",
"examples": [
1
]
},
"product_type": {
"type": "string",
"title": "product type",
"description": "Identifies the type of the product",
"examples": [
"00006"
]
},
"subproduct": {
"type": "string",
"title": "subproduct",
"description": "Subproduct reference code",
"examples": [
"00008"
]
},
"accepted_bankslip": {
"type": "string",
"title": "accepted bank slip",
"description": "Flag to identifies if a bank slip accepts titleship",
"examples": [
"N",
"S"
]
},
"bankslip_wallet": {
"type": "number",
"title": "kind of bank slip wallet",
"description": "Identifies the type of the wallet",
"examples": [
175
]
},
"our_number": {
"type": "string",
"title": "our number",
"description": "Itau's account number",
"examples": [
"00013840"
]
},
"our_number_check_number": {
"type": "string",
"title": "our number check digit",
"examples": [
"3",
"7"
]
},
"bar_code": {
"type": "string",
"title": "bar code",
"description": "Bank slip bar code",
"examples": [
"34191798200000189331750001384032525048415000"
]
},
"due_date": {
"type": "string",
"title": "due date",
"description": "Bank slip due date",
"format": "date",
"examples": [
"2019-08-15"
]
},
"bankslip_type": {
"type": "string",
"title": "bank slip type",
"description": "Identifies the type of bank slip",
"examples": [
"SELF",
"THIRD_PARTY"
]
},
"issue_date": {
"type": "string",
"title": "issue date",
"description": "Bank slip issue date",
"examples": [
"2019-08-15"
]
},
"payment_type": {
"type": "integer",
"description": "Identifies the type of payment",
"examples": [
3
]
},
"allow_partial_payment": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "allow partial payment",
"description": "Flag to identifies if the bank slip accept partial payment",
"examples": [
false,
true,
null
]
},
"digitable_line_number": {
"type": "string",
"title": "digitable line number",
"description": "Bar code with out the formating",
"examples": [
"34191750090138403252850484150003179820000018933"
]
},
"payment_place": {
"type": "string",
"title": "payment place",
"description": "Identifies the type of payment",
"examples": [
"ATE O VENCIMENTO PAGUE EM QUALQUER BANCO OU CORRESPONDENTE NAO BANCARIO. APOS O VENCIMENTO, ACESSE ITAU.COM.BR/BOLETOS E PAGUE EM QUALQUER BANCO OU CORRESPONDENTE NAO BANCARIO."
]
},
"processing_date": {
"type": "string",
"title": "processing date",
"description": "The issue date of the bank slip",
"examples": [
"2019-08-15"
]
},
"bankslip_amount": {
"type": "number",
"title": "bankslip amount",
"description": "The amount of the bank slip",
"examples": [
189.33
]
},
"discount_amount": {
"type": "number",
"title": "discount amount",
"description": "The discount amount to be subtracted from the bankslip_amount",
"examples": [
0
]
},
"other_deductions_amount": {
"type": "number",
"title": "other deductions amount",
"description": "The amount of any other deductions",
"examples": [
0
]
},
"interest_and_penalties_amount": {
"type": "number",
"title": "interest and penalties amount",
"description": "The sum of all interests and penalties charged in the bank slip",
"examples": [
0
]
},
"other_amount": {
"type": "number",
"title": "other amount",
"description": "The sum of all values external taxes charged in the bank slip",
"examples": [
0
]
},
"total_amount_charged": {
"type": "number",
"title": "total amount charged",
"description": "The total amount charged in the bank slip",
"examples": [
0
]
},
"interest_type": {
"type": "number",
"title": "interest type",
"description": "Identifies the type of interest",
"examples": [
5
]
},
"penalties_type": {
"type": "number",
"title": "penalties type",
"description": "Identifies the type of penalties",
"examples": [
3
]
},
"discount_type": {
"type": "number",
"title": "discount type",
"description": "Identifies the type of discount",
"examples": [
0
]
},
"receipt_authorization_type": {
"type": "string",
"title": "receipt authorization type",
"description": "Identifies the type of discount",
"examples": [
"3"
]
},
"account_id": {
"type": "number",
"title": "Account id",
"description": "Pismo's account identifier from bank slip owner",
"examples": [
1,
578,
100012777
]
},
"program_id": {
"type": "number",
"title": "Program id",
"description": "Program identifier under which the account of the bank-slip owner was created",
"examples": [
1,
578,
100012777
]
},
"limit_date": {
"type": "string",
"title": "Limit date",
"description": "Limit date for payment.",
"format": "date",
"examples": [
"2019-08-15"
]
},
"payer": {
"$ref": "#/definitions/payer"
},
"guarantor": {
"$ref": "#/definitions/guarantor"
},
"beneficiary": {
"$ref": "#/definitions/beneficiary"
},
"currency": {
"$ref": "#/definitions/currency"
}
},
"definitions": {
"payer": {
"type": "object",
"title": "Payer",
"description": "Payer informations",
"required": [
"payer_name",
"payer_address",
"payer_city",
"payer_state",
"payer_cep"
],
"properties": {
"cpf_cnpj_payer": {
"type": [
"string",
"null"
],
"title": "cpf cnpj payer",
"description": "Payer document number. Ex: In Brazil is CPF/CNPJ, only numbers",
"examples": [
"00021100080",
"43416178000120"
]
},
"payer_name": {
"type": "string",
"title": "payer name",
"description": "The name of the payer",
"examples": [
"GABRIEL ANTONIO FORTE"
]
},
"payer_address": {
"type": "string",
"title": "payer address",
"description": "The address of the payer",
"examples": [
"ENDERECO DO CLIENTE, 000"
]
},
"payer_neighborhood": {
"type": "string",
"title": "payer neighborhood",
"description": "The neighborhood of the payer",
"examples": [
"BAIRRO"
]
},
"payer_city": {
"type": "string",
"title": "payer city",
"description": "The city of the payer",
"examples": [
"S\u00e3o Paulo"
]
},
"payer_state": {
"type": "string",
"title": "payer state",
"description": "The UF/State/province of the payer",
"examples": [
"SP"
]
},
"payer_cep": {
"type": "string",
"title": "payer postal code",
"description": "The postal code of the payer",
"examples": [
"03720030"
]
}
}
},
"guarantor": {
"type": "object",
"title": "Guarantor",
"description": "Guarantor informations",
"required": [
"guarantor_name",
"guarantor_address",
"guarantor_city",
"guarantor_cep"
],
"properties": {
"cpf_cnpj_guarantor": {
"type": "string",
"title": "guarantor document number",
"description": "Guarantor document number. Ex: In Brazil is CPF/CNPJ, only numbers",
"examples": [
"00021100080",
"43416178000120"
]
},
"guarantor_name": {
"type": "string",
"title": "guarantor name",
"description": "The name of the guarantor",
"examples": [
"GABRIEL ANTONIO FORTE"
]
},
"guarantor_address": {
"type": "string",
"title": "guarantor address",
"description": "The address guarantor",
"examples": [
"ENDERECO DO CLIENTE, 000"
]
},
"guarantor_neighborhood": {
"type": "string",
"title": "guarantor neighborhood",
"description": "The neighborhood guarantor",
"examples": [
"BAIRRO"
]
},
"guarantor_city": {
"type": "string",
"title": "guarantor city",
"description": "The city guarantor",
"examples": [
"S\u00e3o Paulo"
]
},
"guarantor_uf": {
"type": "string",
"title": "guarantor uf",
"description": "The UF/State/province of the guarantor",
"examples": [
"SP"
]
},
"guarantor_cep": {
"type": "string",
"title": "guarantor postal code",
"description": "The postal code of the guarantor",
"examples": [
"03390010"
]
}
}
},
"beneficiary": {
"type": "object",
"title": "Beneficiary",
"description": "Beneficiary informations",
"required": [
"beneficiary_bank",
"beneficiary_bank_check_digit",
"beneficiary_agency",
"beneficiary_accout",
"beneficiary_account_check_digit"
],
"properties": {
"beneficiary_bank": {
"type": "string",
"title": "beneficiary bank",
"description": "The bank code of the beneficiary",
"examples": [
"341"
]
},
"beneficiary_bank_check_digit": {
"type": "string",
"title": "beneficiary bank check digit",
"description": "The bank digit of the beneficiary",
"examples": [
"7"
]
},
"beneficiary_agency": {
"type": "string",
"title": "beneficiary agency",
"description": "The bank agency of the beneficiary",
"examples": [
"2525"
]
},
"beneficiary_accout": {
"type": "string",
"title": "beneficiary account",
"description": "The bank account of the beneficiary",
"examples": [
"04841"
]
},
"beneficiary_account_check_digit": {
"type": "string",
"title": "beneficiary account check digit",
"description": "The bank account check digit of the beneficiary",
"examples": [
"5"
]
},
"beneficiary_cpf_cnpj": {
"type": "string",
"title": "beneficiary document number",
"description": "Beneficiary document number. Ex: In Brazil is CPF/CNPJ, only numbers",
"examples": [
"17192451000170"
]
},
"corporate_name_beneficiary": {
"type": "string",
"title": "beeficiary corporate name",
"description": "The corporate name of the beneficiary",
"examples": [
"ITAUCARD FIN S CRED FINANC INV"
],
"beneficiary_address": {
"type": "string",
"title": "beneficiary address",
"description": "The address of the beneficiary",
"examples": [
"AL PEDRO CALIL"
]
},
"beneficiary_neighborhood": {
"type": "string",
"title": "beneficiary neighborhood",
"description": "The neighborhood of the beneficiary",
"examples": [
"VILA DAS ACACIA"
]
},
"beneficiary_address_complement": {
"type": "string",
"title": "beneficiary address complement ",
"description": "The complement address information of the beneficiary",
"examples": [
""
]
},
"beneficiary_city": {
"type": "string",
"title": "beneficiary city",
"description": "The city of the beneficiary",
"examples": [
"POA"
]
},
"beneficiario_uf": {
"type": "string",
"title": "beneficiary state/province",
"description": "The UF/State/province of the beneficiary",
"examples": [
"SP"
]
},
"beneficiary_cep": {
"type": "string",
"title": "beneficiary postal code",
"description": "The postal code of the beneficiary",
"examples": [
"08557105"
]
}
}
}
},
"currency": {
"type": "object",
"title": "currency",
"description": "Currency informations",
"required": [
"currency_code_cnab",
"currency_amount",
"currency_price"
],
"properties": {
"currency_code_cnab": {
"type": "string",
"title": "currency cnab code",
"description": "The original currency code of the operation",
"examples": [
"09"
]
},
"currency_amount": {
"type": "number",
"title": "currency amount",
"description": "The original currency amount of the operation",
"examples": [
0
]
},
"currency_price": {
"type": "number",
"title": "currency exchange price",
"description": "The exchange price of the operation",
"examples": [
0
]
}
}
}
}
}
{
"registry_type": 1,
"charge_type": 1,
"product_type": "00006",
"subproduct": "00008",
"accepted_bankslip": "N",
"bankslip_wallet": 175,
"our_number": "00013840",
"our_number_check_number": "3",
"bar_code": "34191798200000189331750001384032525048415000",
"due_date": "2019-08-15",
"bankslip_type": "SELF",
"issue_date": "2019-08-15",
"payment_type": 3,
"allow_partial_payment": false,
"digitable_line_number": "34191750090138403252850484150003179820000018933",
"payment_place": "ATE O VENCIMENTO PAGUE EM QUALQUER BANCO OU CORRESPONDENTE NAO BANCARIO. APOS O VENCIMENTO, ACESSE ITAU.COM.BR/BOLETOS E PAGUE EM QUALQUER BANCO OU CORRESPONDENTE NAO BANCARIO.",
"processing_date": "2019-08-15",
"bankslip_amount": 189.33,
"discount_amount": 0,
"other_deductions_amount": 0,
"interest_and_penalties_amount": 0,
"other_amount": 0,
"total_amount_charged": 0,
"interest_type": 5,
"penalties_type": 3,
"discount_type": 0,
"receipt_authorization_type": "3",
"account_id": 1,
"program_id": 1,
"limit_date": "2019-08-15",
"payer": {
"cpf_cnpj_payer": "00021100080",
"payer_name": "GABRIEL ANTONIO FORTE",
"payer_address": "ENDERECO DO CLIENTE, 000",
"payer_neighborhood": "BAIRRO",
"payer_city": "S\u00e3o Paulo",
"payer_state": "SP",
"payer_cep": "03720030"
},
"guarantor": {
"cpf_cnpj_guarantor": "00021100080",
"guarantor_name": "GABRIEL ANTONIO FORTE",
"guarantor_address": "ENDERECO DO CLIENTE, 000",
"guarantor_neighborhood": "BAIRRO",
"guarantor_city": "S\u00e3o Paulo",
"guarantor_uf": "SP",
"guarantor_cep": "03390010"
},
"beneficiary": {
"beneficiary_bank": "341",
"beneficiary_bank_check_digit": "7",
"beneficiary_agency": "2525",
"beneficiary_accout": "04841",
"beneficiary_account_check_digit": "5",
"beneficiary_cpf_cnpj": "17192451000170",
"corporate_name_beneficiary": "ITAUCARD FIN S CRED FINANC INV"
},
"currency": {
"currency_code_cnab": "09",
"currency_amount": 0,
"currency_price": 0
}
}
Updated 16 days ago