Funds received by customer

Type: object
Domain: bankaccounts
Event: cashin
Version: 1

|
transaction_type required

Title: Transaction type
Description: Identifies the type of bankaccounts cash in
Type: string
Example:
TED_CASHIN
TEF_CASHIN

outcome required

Title: Outcome
Description: Outcome of the authorization
Type: string
Example:
SUCCESS
FAILED

processing_code

Title: Processing code
Description: Identifies the process of a authorization
Type: string
Example:
004000
004001
004005
007000
007100
007101
007300
007301
007400
007500
007600
007601
007700

source_holder required

Title: Source account Holder
Description: Source account Holder information
Type: ['object']

name required

Title: Name
Description: Account holder name
Type: string
Example:
Destinatário da Silva

document_number required

Title: Document number
Description: Account holder document number
Type: string
Example:
01969270306

entity_type required

Title: entity type
Description: Identifies if the account holder is a person or a company
Type: string
Example:
F

bank_account required

Title: Bank Account
Description: Bank account information
Type: ['object']

bank required

Title: Bank Code
Description: Identifies the bank
Type: string
Example:
341

agency required

Title: Agency Code
Description: Identifies the bank's agency
Type: string
Example:
0500

account_number required

Title: Account number
Description: Identifier of a specific user's bank account
Type: string
Example:
000000001

account_digit required

Title: Account digit
Description: The digit of the account number
Type: string
Example:
8

account_type required

Title: Account Type
Description: Bank account type
Type: string
Example:
Conta Pagamento

destination_holder required

Title: Destination account Holder
Description: Destination account Holder information
Type: ['object']

name required

Title: Name
Description: Account holder name
Type: string
Example:
Destinatário da Silva

document_number required

Title: Document number
Description: Account holder document number
Type: string
Example:
01969270306

entity_type required

Title: entity type
Description: Identifies if the account holder is a person or a company
Type: string
Example:
F

phone_country_code

Title: Phone country code
Description: Account holder phone country code
Type: string or null
Example:
55

phone_area_code

Title: Phone area code
Description: Account holder phone code of the area (state/uf/province)
Type: string or null
Example:
11

phone_number

Title: Phone number
Description: Account holder phone number
Type: string or null
Example:
988887777

alias

Title: Alias
Description: Account holder alias
Type: string or null
Example:
Destinatário

external_id

Title: External ID
Description: External correlation identifier
Type: string
Example:
b133facc-7db7-4ddb-8b68-946350bd4787

bank_account required

Title: Bank Account
Description: Bank account information
Type: ['object']

bank required

Title: Bank Code
Description: Identifies the bank
Type: string
Max length: 3
Example:
341

agency required

Title: Agency Code
Description: Identifies the bank's agency
Type: string
Max length: 5
Example:
0500

account_number required

Title: Account number
Description: Identifier of a specific user's bank account
Type: string
Max length: 12
Example:
000000001

account_digit required

Title: Account digit
Description: The digit of the account number
Type: string
Example:
8

id required

Title: ID
Description: Bank account id
Type: integer
Example:
123456

account_type

Title: Account Type
Description: Bank account type
Type: string or null
Example:
Conta Pagamento

interoperability required

Title: Interoperability
Description: Unique ID composed by branch and account number
Type: string
Example:
00005000000000000123

status required

Title: Status
Description: Flag that Identifies the status of the bank account
Type: string
Example:
ACTIVE

account_id required

Title: Account ID
Description: Pismo's account identifier
Type: integer
Example:
1

creation_date

Title: Creation Date
Description: Creation date and time of the bank account
Type: string
Example:
2018-08-16T18:55:50Z

last_update

Title: Last Update
Description: Last update date and time of the bank account
Type: string or null
Example:
2018-08-16T18:55:50Z

program_id required

Title: Program ID
Description: Pismo's program identifier of the account holder
Type: integer
Example:
540

amount

Title: Amount
Description: Amount of the authorization
Type: number
Example:
10.4
17.5

authorization_id

Title: Authorization id
Description: The identifier of the authorization
Type: integer
Example:
45672

event_date

Title: Event Date
Description: Date of the authorization
Type: string
Format: date-time
Example:
2019-07-05T12:29:12.300Z

current_balance required

Title: Current balance
Description: Account balance after authorization
Type: number
Example:
100.84
null

anti_fraud

Title: Antifraud
Description: Antifraude information
Type: ['object']

name required

Title: Name
Description: Descriptor of the antifraud origin
Type: string
Example:
simility

external_id required

Title: External ID
Description: Value of the e_id sent by the antifraud engine
Type: string

outcome required

Title: Outcome
Description: Engine check result
Type: string
Example:
SUCCESS
FAILED

engine_response required

Title: Engine response
Description: Antifraude engine response json as string
Type: string

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Funds received by customer",
    "required": [
        "transaction_type",
        "outcome",
        "current_balance",
        "source_holder",
        "destination_holder"
    ],
    "properties": {
        "transaction_type": {
            "type": "string",
            "title": "Transaction type",
            "description": "Identifies the type of bankaccounts cash in",
            "examples": [
                "TED_CASHIN",
                "TEF_CASHIN"
            ]
        },
        "outcome": {
            "type": "string",
            "title": "Outcome",
            "description": "Outcome of the authorization",
            "examples": [
                "SUCCESS",
                "FAILED"
            ]
        },
        "processing_code": {
            "type": "string",
            "title": "Processing code",
            "description": "Identifies the process of a authorization",
            "examples": [
                "004000",
                "004001",
                "004005",
                "007000",
                "007100",
                "007101",
                "007300",
                "007301",
                "007400",
                "007500",
                "007600",
                "007601",
                "007700"
            ]
        },
        "source_holder": {
            "$ref": "#/definitions/source_holder"
        },
        "destination_holder": {
            "$ref": "#/definitions/destination_holder"
        },
        "amount": {
            "type": "number",
            "title": "Amount",
            "description": "Amount of the authorization",
            "examples": [
                10.4,
                17.5
            ]
        },
        "authorization_id": {
            "type": "integer",
            "title": "Authorization id",
            "description": "The identifier of the authorization",
            "examples": [
                45672
            ]
        },
        "event_date": {
            "type": "string",
            "format": "date-time",
            "title": "Event Date",
            "description": "Date of the authorization",
            "examples": [
                "2019-07-05T12:29:12.300Z"
            ]
        },
        "current_balance": {
            "type": "number",
            "title": "Current balance",
            "description": "Account balance after authorization",
            "examples": [
                100.84,
                0
            ]
        },
        "anti_fraud": {
            "$ref": "#/definitions/anti_fraud"
        }
    },
    "definitions": {
        "source_holder": {
            "type": [
                "object"
            ],
            "title": "Source account Holder",
            "description": "Source account Holder information",
            "required": [
                "name",
                "document_number",
                "entity_type",
                "bank_account"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Name",
                    "description": "Account holder name",
                    "examples": [
                        "Destinat\u00e1rio da Silva"
                    ]
                },
                "document_number": {
                    "type": "string",
                    "title": "Document number",
                    "description": "Account holder document number",
                    "examples": [
                        "01969270306"
                    ]
                },
                "entity_type": {
                    "type": "string",
                    "title": "entity type",
                    "description": "Identifies if the account holder is a person or a company",
                    "examples": [
                        "F"
                    ]
                },
                "bank_account": {
                    "$ref": "#/definitions/source_bank_account"
                }
            }
        },
        "destination_holder": {
            "type": [
                "object"
            ],
            "title": "Destination account Holder",
            "description": "Destination account Holder information",
            "required": [
                "name",
                "document_number",
                "entity_type",
                "bank_account"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Name",
                    "description": "Account holder name",
                    "examples": [
                        "Destinat\u00e1rio da Silva"
                    ]
                },
                "document_number": {
                    "type": "string",
                    "title": "Document number",
                    "description": "Account holder document number",
                    "examples": [
                        "01969270306"
                    ]
                },
                "entity_type": {
                    "type": "string",
                    "title": "entity type",
                    "description": "Identifies if the account holder is a person or a company",
                    "examples": [
                        "F"
                    ]
                },
                "phone_country_code": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Phone country code",
                    "description": "Account holder phone country code",
                    "examples": [
                        "55"
                    ]
                },
                "phone_area_code": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Phone area code",
                    "description": "Account holder phone code of the area (state/uf/province)",
                    "examples": [
                        "11"
                    ]
                },
                "phone_number": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Phone number",
                    "description": "Account holder phone number",
                    "examples": [
                        "988887777"
                    ]
                },
                "alias": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Alias",
                    "description": "Account holder alias",
                    "examples": [
                        "Destinat\u00e1rio"
                    ]
                },
                "external_id": {
                    "type": "string",
                    "title": "External ID",
                    "description": "External correlation identifier",
                    "examples": [
                        "b133facc-7db7-4ddb-8b68-946350bd4787"
                    ]
                },
                "bank_account": {
                    "$ref": "#/definitions/destination_bank_account"
                }
            }
        },
        "source_bank_account": {
            "type": [
                "object"
            ],
            "title": "Bank Account",
            "description": "Bank account information",
            "required": [
                "bank",
                "agency",
                "account_number",
                "account_digit",
                "account_type"
            ],
            "properties": {
                "bank": {
                    "type": "string",
                    "title": "Bank Code",
                    "description": "Identifies the bank",
                    "examples": [
                        "341"
                    ]
                },
                "agency": {
                    "type": "string",
                    "title": "Agency Code",
                    "description": "Identifies the bank's agency",
                    "examples": [
                        "0500"
                    ]
                },
                "account_number": {
                    "type": "string",
                    "title": "Account number",
                    "description": "Identifier of a specific user's bank account",
                    "examples": [
                        "000000001"
                    ]
                },
                "account_digit": {
                    "type": "string",
                    "title": "Account digit",
                    "description": "The digit of the account number",
                    "examples": [
                        "8"
                    ]
                },
                "account_type": {
                    "type": "string",
                    "title": "Account Type",
                    "description": "Bank account type",
                    "examples": [
                        "Conta Pagamento"
                    ]
                }
            }
        },
        "destination_bank_account": {
            "type": [
                "object"
            ],
            "title": "Bank Account",
            "description": "Bank account information",
            "required": [
                "bank",
                "agency",
                "account_number",
                "account_digit",
                "id",
                "interoperability",
                "status",
                "program_id",
                "account_id"
            ],
            "properties": {
                "bank": {
                    "type": "string",
                    "maxLength": 3,
                    "title": "Bank Code",
                    "description": "Identifies the bank",
                    "examples": [
                        "341"
                    ]
                },
                "agency": {
                    "type": "string",
                    "maxLength": 5,
                    "title": "Agency Code",
                    "description": "Identifies the bank's agency",
                    "examples": [
                        "0500"
                    ]
                },
                "account_number": {
                    "type": "string",
                    "maxLength": 12,
                    "title": "Account number",
                    "description": "Identifier of a specific user's bank account",
                    "examples": [
                        "000000001"
                    ]
                },
                "account_digit": {
                    "type": "string",
                    "title": "Account digit",
                    "description": "The digit of the account number",
                    "examples": [
                        "8"
                    ]
                },
                "id": {
                    "type": "integer",
                    "title": "ID",
                    "description": "Bank account id",
                    "examples": [
                        123456
                    ]
                },
                "account_type": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Account Type",
                    "description": "Bank account type",
                    "examples": [
                        "Conta Pagamento"
                    ]
                },
                "interoperability": {
                    "type": "string",
                    "title": "Interoperability",
                    "description": "Unique ID composed by branch and account number",
                    "examples": [
                        "00005000000000000123"
                    ]
                },
                "status": {
                    "type": "string",
                    "title": "Status",
                    "description": "Flag that Identifies the status of the bank account",
                    "examples": [
                        "ACTIVE"
                    ]
                },
                "account_id": {
                    "type": "integer",
                    "title": "Account ID",
                    "description": "Pismo's account identifier",
                    "examples": [
                        1
                    ]
                },
                "creation_date": {
                    "type": "string",
                    "title": "Creation Date",
                    "description": "Creation date and time of the bank account",
                    "examples": [
                        "2018-08-16T18:55:50Z"
                    ]
                },
                "last_update": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Last Update",
                    "description": "Last update date and time of the bank account",
                    "examples": [
                        "2018-08-16T18:55:50Z"
                    ]
                },
                "program_id": {
                    "type": "integer",
                    "title": "Program ID",
                    "description": "Pismo's program identifier of the account holder",
                    "examples": [
                        540
                    ]
                }
            }
        },
        "anti_fraud": {
            "type": [
                "object"
            ],
            "title": "Antifraud",
            "description": "Antifraude information",
            "required": [
                "name",
                "external_id",
                "outcome",
                "engine_response"
            ],
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Name",
                    "description": "Descriptor of the antifraud origin",
                    "examples": [
                        "simility"
                    ]
                },
                "external_id": {
                    "type": "string",
                    "title": "External ID",
                    "description": "Value of the e_id sent by the antifraud engine"
                },
                "outcome": {
                    "type": "string",
                    "title": "Outcome",
                    "description": "Engine check result",
                    "examples": [
                        "SUCCESS",
                        "FAILED"
                    ]
                },
                "engine_response": {
                    "type": "string",
                    "title": "Engine response",
                    "description": "Antifraude engine response json as string"
                }
            }
        }
    }
}