About PismoContact Us

BCB SPB transfer processed

Type: object
Domain: bacen-spb
Event: str
Version: 1

|
str_message_code required

Title: STR Message Code
Description: The message code received from the provider. It refers to the BACEN field CdMensagem
Type: string
Example:
STR0008

if_control_id

Title: IF Control Identifier
Description: The IF control code received from the provider. It refers to the BACEN field NumCtrlIF
Type: string
Example:
123456

str_control_id

Title: STR Control Identifier
Description: The STR control code received from the provider. It refers to the BACEN field NumCtrlSTR
Type: string
Example:
123456

str_reversal_control_id

Title: STR Reversal Control Identifier
Description: The STR control code received from the provider on reversal flow (STR0010R2). It refers to the BACEN field NumCtrlSTR
Type: string
Example:
123456

external_reversal_code

Title: External Reversal Code
Description: The external reversal code which received from the provider. It refers to the BACEN field CodDevTransf
Type: string
Example:
1

type required

Title: Transaction Type
Description: Type of the transaction
Type: string
Example:
CASHOUT
CASHIN

status required

Title: Status
Description: Status of the transaction
Type: string
Example:
PROCESSING
SETTLED
REVERTED
ERROR

account_id

Title: Account Identifier
Description: Unique account identifier at Pismo Platform
Type: integer
Example:
123

authorization_id

Title: Authorization Identifier
Description: Authorization Identifier on Pismo platform
Type: integer
Example:
123

correlation_id required

Title: Correlation Identifier
Description: Pismo platform correlation identifier used on the entire flow
Type: string
Format: uuid
Example:
562c3bbf-5cd9-4d36-a693-5020f551476b

amount required

Title: transaction amount
Description: The amount of the transaction
Type: number
Format: double
Example:
20.15

error_code

Title: Error code
Description: Internal error code of the application
Type: string
Example:
EBS0001

error_message

Title: Error Message
Description: Error details
Type: string
Example:
invalid bank account

from

Title: Source information
Description: Source information. Who sent the money.
Type: ['object']

ispb

Title: ISPB
Description: Source bank ISPB
Type: string
Example:
12345678

branch

Title: Branch
Description: Source bank branch
Type: string
Example:
0123

account_number

Title: Account Number
Description: Source bank account number
Type: string
Example:
0123456

document_number

Title: Document Number
Description: Source document number
Type: string
Example:
12345689

name

Title: Name
Description: Source name
Type: string
Example:
JOAO

to

Title: Destination information
Description: Destination information. Who receives the money.
Type: ['object']

ispb

Title: ISPB
Description: Destination bank ISPB
Type: string
Example:
12345678

branch

Title: Branch
Description: Destination bank branch
Type: string
Example:
0123

account_number

Title: Account Number
Description: Destination bank account number
Type: string
Example:
0123456

document_number

Title: Document Number
Description: Destination document number
Type: string
Example:
12345689

name

Title: Name
Description: Destination name
Type: string
Example:
JOAO

 
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "BCB SPB transfer processed",
    "required": [
        "str_message_code",
        "type",
        "status",
        "correlation_id",
        "amount"
    ],
    "properties": {
        "str_message_code": {
            "type": "string",
            "title": "STR Message Code",
            "description": "The message code received from the provider. It refers to the BACEN field CdMensagem",
            "examples": [
                "STR0008"
            ]
        },
        "if_control_id": {
            "type": "string",
            "title": "IF Control Identifier",
            "description": "The IF control code received from the provider. It refers to the BACEN field NumCtrlIF",
            "examples": [
                "123456"
            ]
        },
        "str_control_id": {
            "type": "string",
            "title": "STR Control Identifier",
            "description": "The STR control code received from the provider. It refers to the BACEN field NumCtrlSTR",
            "examples": [
                "123456"
            ]
        },
        "str_reversal_control_id": {
            "type": "string",
            "title": "STR Reversal Control Identifier",
            "description": "The STR control code received from the provider on reversal flow (STR0010R2). It refers to the BACEN field NumCtrlSTR",
            "examples": [
                "123456"
            ]
        },
        "external_reversal_code": {
            "type": "string",
            "title": "External Reversal Code",
            "description": "The external reversal code which received from the provider. It refers to the BACEN field CodDevTransf",
            "examples": [
                "1"
            ]
        },
        "type": {
            "type": "string",
            "title": "Transaction Type",
            "description": "Type of the transaction",
            "examples": [
                "CASHOUT",
                "CASHIN"
            ]
        },
        "status": {
            "type": "string",
            "title": "Status",
            "description": "Status of the transaction",
            "examples": [
                "PROCESSING",
                "SETTLED",
                "REVERTED",
                "ERROR"
            ]
        },
        "account_id": {
            "type": "integer",
            "title": "Account Identifier",
            "description": "Unique account identifier at Pismo Platform",
            "examples": [
                123
            ]
        },
        "authorization_id": {
            "type": "integer",
            "title": "Authorization Identifier",
            "description": "Authorization Identifier on Pismo platform",
            "examples": [
                123
            ]
        },
        "correlation_id": {
            "type": "string",
            "format": "uuid",
            "title": "Correlation Identifier",
            "description": "Pismo platform correlation identifier used on the entire flow",
            "examples": [
                "562c3bbf-5cd9-4d36-a693-5020f551476b"
            ]
        },
        "amount": {
            "type": "number",
            "format": "double",
            "title": "transaction amount",
            "description": "The amount of the transaction",
            "examples": [
                20.15
            ]
        },
        "error_code": {
            "type": "string",
            "title": "Error code",
            "description": "Internal error code of the application",
            "examples": [
                "EBS0001"
            ]
        },
        "error_message": {
            "type": "string",
            "title": "Error Message",
            "description": "Error details",
            "examples": [
                "invalid bank account"
            ]
        },
        "from": {
            "$ref": "#/definitions/from"
        },
        "to": {
            "$ref": "#/definitions/to"
        }
    },
    "definitions": {
        "from": {
            "type": [
                "object"
            ],
            "title": "Source information",
            "description": "Source information. Who sent the money.",
            "properties": {
                "ispb": {
                    "type": "string",
                    "title": "ISPB",
                    "description": "Source bank ISPB",
                    "examples": [
                        "12345678"
                    ]
                },
                "branch": {
                    "type": "string",
                    "title": "Branch",
                    "description": "Source bank branch",
                    "examples": [
                        "0123"
                    ]
                },
                "account_number": {
                    "type": "string",
                    "title": "Account Number",
                    "description": "Source bank account number",
                    "examples": [
                        "0123456"
                    ]
                },
                "document_number": {
                    "type": "string",
                    "title": "Document Number",
                    "description": "Source document number",
                    "examples": [
                        "12345689"
                    ]
                },
                "name": {
                    "type": "string",
                    "title": "Name",
                    "description": "Source name",
                    "examples": [
                        "JOAO"
                    ]
                }
            }
        },
        "to": {
            "type": [
                "object"
            ],
            "title": "Destination information",
            "description": "Destination information. Who receives the money.",
            "properties": {
                "ispb": {
                    "type": "string",
                    "title": "ISPB",
                    "description": "Destination bank ISPB",
                    "examples": [
                        "12345678"
                    ]
                },
                "branch": {
                    "type": "string",
                    "title": "Branch",
                    "description": "Destination bank branch",
                    "examples": [
                        "0123"
                    ]
                },
                "account_number": {
                    "type": "string",
                    "title": "Account Number",
                    "description": "Destination bank account number",
                    "examples": [
                        "0123456"
                    ]
                },
                "document_number": {
                    "type": "string",
                    "title": "Document Number",
                    "description": "Destination document number",
                    "examples": [
                        "12345689"
                    ]
                },
                "name": {
                    "type": "string",
                    "title": "Name",
                    "description": "Destination name",
                    "examples": [
                        "JOAO"
                    ]
                }
            }
        }
    }
}

{
    "str_message_code": "STR0008",
    "if_control_id": "123456",
    "str_control_id": "123456",
    "str_reversal_control_id": "123456",
    "external_reversal_code": "1",
    "type": "CASHOUT",
    "status": "PROCESSING",
    "account_id": 123,
    "authorization_id": 123,
    "correlation_id": "562c3bbf-5cd9-4d36-a693-5020f551476b",
    "amount": 20.15,
    "error_code": "EBS0001",
    "error_message": "invalid bank account",
    "from": {
        "ispb": "12345678",
        "branch": "0123",
        "account_number": "0123456",
        "document_number": "12345689",
        "name": "JOAO"
    },
    "to": {
        "ispb": "12345678",
        "branch": "0123",
        "account_number": "0123456",
        "document_number": "12345689",
        "name": "JOAO"
    }
}

Updated 16 days ago