Cashout transfer completed

Type: object
Domain: audit
Event: transfer_cash_out
Version: 1

|
method required

Title: Method
Description: The operation HTTP method
Type: string
Example:
POST

uri required

Title: URI
Description: The API operation URI
Type: string
Example:
/v1/roles-approve/transfers

email required

Title: E-mail
Description: The operator email
Type: string
Example:
[email protected]

roles required

Title: Roles
Description: Pre-defined groups of privileges
Type: array
Example:

[
    "backoffice-operator",
    "crm-operator",
    "geroficios-operator",
    "inspetoria-master",
    "inspetoria-operator",
    "itibackoffice-master",
    "itibackoffice-operator",
    "itinivel1-operator",
    "treasury-operator"
]
origin required

Title: Origin
Description: The interface through which the event originates
Type: string or null
Example:
CRM
APP

object required

Title: Object
Description: The audit data message
Type: object

authorization_id required

Title: Authorization ID
Description: Identifies an authorization on Pismo's platform
Type: integer
Example:
14125

event_date required

Title: Event date
Description: The event date and time in ISO 8601
Type: string
Example:
2019-09-18T18:09:39.432Z

type required

Title: Type
Description: The transfer type
Type: string
Example:
OP
TED
TEF

amount required

Title: Amount
Description: The amount value
Type: number
Example:
0.01

mdr required

Title: MDR
Description: MDR means merchant discount rate. In other words, is how much the processor of the credit card charges over the operation
Type: number
Example:
null

cash_back required

Title: Cash back
Description: The cash back value
Type: number or null
Example:
null

iti_discount required

Title: Iti discount
Description: The Iti discount value
Type: integer
Example:
null

entry_mode required

Title: Entry mode
Description: The Entry mode Type
Type: string or null
Example:
POS
QRCODE

source_holder required

Title: Source holder
Description: The source holder Object
Type: object

name required

Title: Name
Description: Account holder's name
Type: string or null
Example:
Joao
Iti user

document_number required

Title: Document number
Description: The document number (CPF, CNPJ) value
Type: string or null
Example:
38258325205
38426982000150

entity_type required

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

phone_country_code required

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

phone_area_code required

Title: Phone area code
Description: The phone code area
Type: string or null
Example:
11

phone_number required

Title: Phone number
Description: The phone number
Type: string or null
Example:
989354983

bankaccount required

Title: Bank Account
Description: The bank account Object
Type: object

bank required

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

bank_name required

Title: Bank name
Description: The name of the bank
Type: string or null
Example:
Itaú Unibanco S.A.

branch required

Title: Branch Code
Description: Identifies the bank's branch
Type: string
Example:
0500

account_number required

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

check_digit required

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

program_id required

Title: Program ID
Description: Program ID of the source holder
Type: integer or null
Example:
540

account_id required

Title: Account ID
Description: Pismo's account identifier
Type: integer or null
Example:
21563

status required

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

destination_holder required

Title: Destination holder
Description: The destination holder object
Type: object

authorization_id

Title: Authorization ID
Description: The authorization identifier
Type: integer
Example:
14125

event_date

Title: Event date
Description: The event date and time in ISO 8601
Type: string
Example:
2019-09-18T18:09:39.432Z

type

Title: Type
Description: The transfer type
Type: string
Example:
OP
TED
TEF

amount

Title: Amount
Description: The amount value
Type: number
Example:
0.01

mdr

Title: MDR
Description: The mdr value
Type: number
Example:
null

cash_back

Title: Cash back
Description: The cash back value
Type: number or null
Example:
null

iti_discount

Title: Iti discount
Description: The Iti discount value
Type: integer
Example:
null

entry_mode

Title: Entry mode
Description: The Entry mode Type
Type: string or null
Example:
POS
QRCODE

source_holder

Title: Source holder
Description: The source holder Object
Type: object

name required

Title: Name
Description: Account holder's name
Type: string or null
Example:
Joao
Iti user

document_number required

Title: Document number
Description: The document number (CPF, CNPJ) value
Type: string or null
Example:
38258325205

entity_type required

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

phone_country_code required

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

phone_area_code required

Title: Phone area code
Description: The phone code area
Type: string or null
Example:
11

phone_number required

Title: Phone number
Description: The phone number
Type: string or null
Example:
989354983

bankaccount required

Title: Bank Account
Description: The bank account Object
Type: object

bank required

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

bank_name required

Title: Bank name
Description: The name of the bank
Type: string or null
Example:
Itaú Unibanco S.A.

branch required

Title: Branch Code
Description: Identifies the bank's branch
Type: string
Example:
0500

account_number required

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

check_digit required

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

program_id required

Title: Program ID
Description: Program ID of the source holder
Type: integer or null
Example:
540

account_id required

Title: Account ID
Description: Pismo's account identifier
Type: integer or null
Example:
21563

status required

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

payment_details required

Title: Payment details
Description: The payment detailsi information
Type: object

type required

Title: Type
Description: The payment type
Type: string
Example:
CASH

payment_reason required

Title: Payment reason
Description: The reason from this cash out
Type: string or null
Example:
00010

is_same_owner required

Title: Is same owner
Description: Flag to identifies if a cash out goes to the same owner
Type: boolean
Example:
true
false

skip_rules required

Title: Skip rule
Description: Flag that identifies if it skipped rules check
Type: boolean or null
Example:
true
false

{
    "$id": "http://example.com/root.json",
    "type": "object",
    "title": "Cashout transfer completed",
    "required": [
        "method",
        "uri",
        "email",
        "roles",
        "origin",
        "object"
    ],
    "properties": {
        "method": {
            "type": "string",
            "title": "Method",
            "description": "The operation HTTP method",
            "examples": [
                "POST"
            ]
        },
        "uri": {
            "type": "string",
            "title": "URI",
            "description": "The API operation URI",
            "examples": [
                "/v1/roles-approve/transfers"
            ]
        },
        "email": {
            "type": "string",
            "title": "E-mail",
            "description": "The operator email",
            "examples": [
                "[email protected]"
            ]
        },
        "roles": {
            "type": "array",
            "title": "Roles",
            "description": "Pre-defined groups of privileges",
            "items": {
                "type": [
                    "string",
                    "null"
                ],
                "title": "Items",
                "description": "The roles",
                "examples": [
                    "backoffice-operator",
                    "crm-operator",
                    "geroficios-operator",
                    "inspetoria-master",
                    "inspetoria-operator",
                    "itibackoffice-master",
                    "itibackoffice-operator",
                    "itinivel1-operator",
                    "treasury-operator"
                ]
            }
        },
        "origin": {
            "type": [
                "string",
                "null"
            ],
            "title": "Origin",
            "description": "The interface through which the event originates",
            "examples": [
                "CRM",
                "APP"
            ]
        },
        "object": {
            "type": "object",
            "title": "Object",
            "description": "The audit data message",
            "required": [
                "authorization_id",
                "event_date",
                "type",
                "amount",
                "mdr",
                "cash_back",
                "iti_discount",
                "entry_mode",
                "source_holder",
                "destination_holder"
            ],
            "properties": {
                "authorization_id": {
                    "type": "integer",
                    "title": "Authorization ID",
                    "description": "Identifies an authorization on Pismo's platform",
                    "examples": [
                        14125
                    ]
                },
                "event_date": {
                    "type": "string",
                    "title": "Event date",
                    "description": "The event date and time in ISO 8601",
                    "examples": [
                        "2019-09-18T18:09:39.432Z"
                    ]
                },
                "type": {
                    "type": "string",
                    "title": "Type",
                    "description": "The transfer type",
                    "examples": [
                        "OP",
                        "TED",
                        "TEF"
                    ]
                },
                "amount": {
                    "type": "number",
                    "title": "Amount",
                    "description": "The amount value",
                    "examples": [
                        0.01
                    ]
                },
                "mdr": {
                    "type": "number",
                    "title": "MDR",
                    "description": "MDR means merchant discount rate. In other words, is how much the processor of the credit card charges over the operation",
                    "examples": [
                        0.0
                    ]
                },
                "cash_back": {
                    "type": [
                        "number",
                        "null"
                    ],
                    "title": "Cash back",
                    "description": "The cash back value",
                    "examples": [
                        0.0
                    ]
                },
                "iti_discount": {
                    "type": "integer",
                    "title": "Iti discount",
                    "description": "The Iti discount value",
                    "default": 0.0,
                    "examples": [
                        0.0
                    ]
                },
                "entry_mode": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Entry mode",
                    "description": "The Entry mode Type",
                    "examples": [
                        "POS",
                        "QRCODE"
                    ]
                },
                "source_holder": {
                    "type": "object",
                    "title": "Source holder",
                    "description": "The source holder Object",
                    "required": [
                        "name",
                        "document_number",
                        "entity_type",
                        "phone_country_code",
                        "phone_area_code",
                        "phone_number",
                        "bankaccount"
                    ],
                    "properties": {
                        "name": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Name",
                            "description": "Account holder's name",
                            "examples": [
                                "Joao",
                                "Iti user"
                            ]
                        },
                        "document_number": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Document number",
                            "description": "The document number (CPF, CNPJ) value",
                            "examples": [
                                "38258325205",
                                "38426982000150"
                            ]
                        },
                        "entity_type": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "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": "The phone country code",
                            "examples": [
                                "55"
                            ]
                        },
                        "phone_area_code": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Phone area code",
                            "description": "The phone code area",
                            "examples": [
                                "11"
                            ]
                        },
                        "phone_number": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Phone number",
                            "description": "The phone number",
                            "examples": [
                                "989354983"
                            ]
                        },
                        "bankaccount": {
                            "type": "object",
                            "title": "Bank Account",
                            "description": "The bank account Object",
                            "required": [
                                "bank",
                                "bank_name",
                                "branch",
                                "account_number",
                                "check_digit",
                                "program_id",
                                "account_id",
                                "status"
                            ],
                            "properties": {
                                "bank": {
                                    "type": "string",
                                    "maxLength": 3,
                                    "title": "Bank Code",
                                    "description": "Identifies the bank",
                                    "examples": [
                                        "341"
                                    ]
                                },
                                "bank_name": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "title": "Bank name",
                                    "description": "The name of the bank",
                                    "examples": [
                                        "Ita\u00fa Unibanco S.A."
                                    ]
                                },
                                "branch": {
                                    "type": "string",
                                    "title": "Branch Code",
                                    "description": "Identifies the bank's branch",
                                    "examples": [
                                        "0500"
                                    ]
                                },
                                "account_number": {
                                    "type": "string",
                                    "title": "Account number",
                                    "description": "identifier of a specific user's bank account",
                                    "examples": [
                                        "014943015"
                                    ]
                                },
                                "check_digit": {
                                    "type": "string",
                                    "title": "Check digit",
                                    "description": "The check digit of the account number",
                                    "examples": [
                                        "8"
                                    ]
                                },
                                "program_id": {
                                    "type": [
                                        "integer",
                                        "null"
                                    ],
                                    "title": "Program ID",
                                    "description": "Program ID of the source holder",
                                    "examples": [
                                        540
                                    ]
                                },
                                "account_id": {
                                    "type": [
                                        "integer",
                                        "null"
                                    ],
                                    "title": "Account ID",
                                    "description": "Pismo's account identifier",
                                    "examples": [
                                        21563
                                    ]
                                },
                                "status": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "title": "Status",
                                    "description": "Flag that Identifies the status of the bank account",
                                    "examples": [
                                        "ACTIVE"
                                    ]
                                }
                            }
                        }
                    }
                },
                "destination_holder": {
                    "type": "object",
                    "title": "Destination holder",
                    "description": "The destination holder object",
                    "required": [
                        "payment_details"
                    ],
                    "properties": {
                        "authorization_id": {
                            "type": "integer",
                            "title": "Authorization ID",
                            "description": "The authorization identifier",
                            "examples": [
                                14125
                            ]
                        },
                        "event_date": {
                            "type": "string",
                            "title": "Event date",
                            "description": "The event date and time in ISO 8601",
                            "examples": [
                                "2019-09-18T18:09:39.432Z"
                            ]
                        },
                        "type": {
                            "type": "string",
                            "title": "Type",
                            "description": "The transfer type",
                            "examples": [
                                "OP",
                                "TED",
                                "TEF"
                            ]
                        },
                        "amount": {
                            "type": "number",
                            "title": "Amount",
                            "description": "The amount value",
                            "examples": [
                                0.01
                            ]
                        },
                        "mdr": {
                            "type": "number",
                            "title": "MDR",
                            "description": "The mdr value",
                            "examples": [
                                0.0
                            ]
                        },
                        "cash_back": {
                            "type": [
                                "number",
                                "null"
                            ],
                            "title": "Cash back",
                            "description": "The cash back value",
                            "examples": [
                                0.0
                            ]
                        },
                        "iti_discount": {
                            "type": "integer",
                            "title": "Iti discount",
                            "description": "The Iti discount value",
                            "default": 0.0,
                            "examples": [
                                0.0
                            ]
                        },
                        "entry_mode": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Entry mode",
                            "description": "The Entry mode Type",
                            "examples": [
                                "POS",
                                "QRCODE"
                            ]
                        },
                        "source_holder": {
                            "type": "object",
                            "title": "Source holder",
                            "description": "The source holder Object",
                            "required": [
                                "name",
                                "document_number",
                                "entity_type",
                                "phone_country_code",
                                "phone_area_code",
                                "phone_number",
                                "bankaccount"
                            ],
                            "properties": {
                                "name": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "title": "Name",
                                    "description": "Account holder's name",
                                    "examples": [
                                        "Joao",
                                        "Iti user"
                                    ]
                                },
                                "document_number": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "title": "Document number",
                                    "description": "The document number (CPF, CNPJ) value",
                                    "examples": [
                                        "38258325205"
                                    ]
                                },
                                "entity_type": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "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": "The phone country code",
                                    "examples": [
                                        "55"
                                    ]
                                },
                                "phone_area_code": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "title": "Phone area code",
                                    "description": "The phone code area",
                                    "examples": [
                                        "11"
                                    ]
                                },
                                "phone_number": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "title": "Phone number",
                                    "description": "The phone number",
                                    "examples": [
                                        "989354983"
                                    ]
                                },
                                "bankaccount": {
                                    "type": "object",
                                    "title": "Bank Account",
                                    "description": "The bank account Object",
                                    "required": [
                                        "bank",
                                        "bank_name",
                                        "branch",
                                        "account_number",
                                        "check_digit",
                                        "program_id",
                                        "account_id",
                                        "status"
                                    ],
                                    "properties": {
                                        "bank": {
                                            "type": "string",
                                            "maxLength": 3,
                                            "title": "Bank Code",
                                            "description": "Identifies the bank",
                                            "examples": [
                                                "341"
                                            ]
                                        },
                                        "bank_name": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "title": "Bank name",
                                            "description": "The name of the bank",
                                            "examples": [
                                                "Ita\u00fa Unibanco S.A."
                                            ]
                                        },
                                        "branch": {
                                            "type": "string",
                                            "title": "Branch Code",
                                            "description": "Identifies the bank's branch",
                                            "examples": [
                                                "0500"
                                            ]
                                        },
                                        "account_number": {
                                            "type": "string",
                                            "title": "Account number",
                                            "description": "identifier of a specific user's bank account",
                                            "examples": [
                                                "014943015"
                                            ]
                                        },
                                        "check_digit": {
                                            "type": "string",
                                            "title": "Check digit",
                                            "description": "The check digit of the account number",
                                            "examples": [
                                                "8"
                                            ]
                                        },
                                        "program_id": {
                                            "type": [
                                                "integer",
                                                "null"
                                            ],
                                            "title": "Program ID",
                                            "description": "Program ID of the source holder",
                                            "examples": [
                                                540
                                            ]
                                        },
                                        "account_id": {
                                            "type": [
                                                "integer",
                                                "null"
                                            ],
                                            "title": "Account ID",
                                            "description": "Pismo's account identifier",
                                            "examples": [
                                                21563
                                            ]
                                        },
                                        "status": {
                                            "type": [
                                                "string",
                                                "null"
                                            ],
                                            "title": "Status",
                                            "description": "Flag that Identifies the status of the bank account",
                                            "examples": [
                                                "ACTIVE"
                                            ]
                                        }
                                    }
                                }
                            }
                        },
                        "payment_details": {
                            "type": "object",
                            "title": "Payment details",
                            "description": "The payment detailsi information",
                            "required": [
                                "type",
                                "payment_reason",
                                "is_same_owner",
                                "skip_rules"
                            ],
                            "properties": {
                                "type": {
                                    "type": "string",
                                    "title": "Type",
                                    "description": "The payment type",
                                    "default": "",
                                    "examples": [
                                        "CASH"
                                    ]
                                },
                                "payment_reason": {
                                    "type": [
                                        "string",
                                        "null"
                                    ],
                                    "title": "Payment reason",
                                    "description": "The reason from this cash out",
                                    "examples": [
                                        "00010"
                                    ]
                                },
                                "is_same_owner": {
                                    "type": "boolean",
                                    "title": "Is same owner",
                                    "description": "Flag to identifies if a cash out goes to the same owner",
                                    "default": false,
                                    "examples": [
                                        true,
                                        false
                                    ]
                                },
                                "skip_rules": {
                                    "type": [
                                        "boolean",
                                        "null"
                                    ],
                                    "title": "Skip rule",
                                    "description": "Flag that identifies if it skipped rules check",
                                    "default": false,
                                    "examples": [
                                        true,
                                        false
                                    ]
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
{
    "method": "POST",
    "uri": "/v1/roles-approve/transfers",
    "email": "[email protected]",
    "roles": [
        "backoffice-operator",
        "crm-operator",
        "geroficios-operator",
        "inspetoria-master",
        "inspetoria-operator",
        "itibackoffice-master",
        "itibackoffice-operator",
        "itinivel1-operator",
        "treasury-operator"
    ],
    "origin": "CRM",
    "object": {
        "authorization_id": 14125,
        "event_date": "2019-09-18T18:09:39.432Z",
        "type": "OP",
        "amount": 0.01,
        "mdr": 0.0,
        "cash_back": 0.0,
        "iti_discount": 0.0,
        "entry_mode": "POS",
        "source_holder": {
            "name": "Joao",
            "document_number": "38258325205",
            "entity_type": "F",
            "phone_country_code": "55",
            "phone_area_code": "11",
            "phone_number": "989354983",
            "bankaccount": {
                "bank": "341",
                "bank_name": "Ita\u00fa Unibanco S.A.",
                "branch": "0500",
                "account_number": "014943015",
                "check_digit": "8",
                "program_id": 540,
                "account_id": 21563,
                "status": "ACTIVE"
            }
        },
        "destination_holder": {
            "authorization_id": 14125,
            "event_date": "2019-09-18T18:09:39.432Z",
            "type": "OP",
            "amount": 0.01,
            "mdr": 0.0,
            "cash_back": 0.0,
            "iti_discount": 0.0,
            "entry_mode": "POS",
            "source_holder": {
                "name": "Joao",
                "document_number": "38258325205",
                "entity_type": "F",
                "phone_country_code": "55",
                "phone_area_code": "11",
                "phone_number": "989354983",
                "bankaccount": {
                    "bank": "341",
                    "bank_name": "Ita\u00fa Unibanco S.A.",
                    "branch": "0500",
                    "account_number": "014943015",
                    "check_digit": "8",
                    "program_id": 540,
                    "account_id": 21563,
                    "status": "ACTIVE"
                }
            },
            "payment_details": {
                "type": "CASH",
                "payment_reason": "00010",
                "is_same_owner": true,
                "skip_rules": true
            }
        }
    }
}