Unit receivable n
Unit receivable received
Type: object
Domain: depositary
Event: unit_receivable
Version: 1
external_id
Title: External ID
Description: Identifier for a receivable unit given by the client
Type: string
Example:
external-id
merchant_document_number required
Title: Merchant document number
Description: Document number of merchant
Type: string
Example:
62543463000157
status
Title: Status
Description: Represents the status of a processed Receivable Unit
Type: string
Example:
PENDING
payment_arrangement required
Title: Payment Arrangement
Description: Represents code of payment arrangement
Type: string
Example:
MCC
settlement_date required
Title: Settlement Date
Description: Settlement date for payment
Type: string
Format: date
Example:
2022-12-01
owner_document_number
Title: Owner Document Number
Description: Document number of owner
Type: string
Example:
20481714000176
composed_value
Title: Composed Value
Description: Represents the composed value to pay
Type: number
Format: double
Example:
10.0
retained_composed_value
Title: Retained Composed Value
Description: Represents the retained composed value to pay
Type: number
Format: double
Example:
10.0
blocked_value
Title: Blocked Value
Description: Represents the blocked value
Type: number
Format: double
Example:
10.0
acquirer_document_number required
Title: Acquirer Document Number
Description: Acquirer document number
Type: string
Example:
20481714683595
payments
Title: List of payments
Description: List of payments linked to Receivable Unit
Type: arrayresidence_owner_document_number required
Title: Residence Owner Document Number
Description: Document number of residence owner
Type: string
Example:
20481714000176
account_type required
Title: Account Type
Description: Represents the type of an account
Type: string
Example:
CC, CD, PG, PP
compe_code
Title: COMPE Code
Description: COMPE Code of Institution
Type: string
Example:
compe-code
ispb required
Title: ISPB
Description: ISPB number of Institution
Type: integer
Example:
20481714
branch_bank
Title: Branch Bank
Description: Represents the branch bank
Type: string
Example:
branch-bank
account_number required
Title: Account Number
Description: Represents the number of bank account
Type: string
Example:
20481714000176
amount_to_pay
Title: Amount to Pay
Description: Represents the amount value to pay
Type: number
Format: double
Example:
10.0
real_settlement_date
Title: Real Settlement Date
Description: Real settlement date for payment
Type: string
Format: date
Example:
2022-12-01
real_settlement_value
Title: Real Settlement value
Description: Real settlement value
Type: number
Format: double
Example:
10.0
message
Title: Error message
Description: Message refers to the process of failure when trying to update Receivable Unit
Type: string
Example:
Receivable Unit not found
Unit Receivable Create Success
operation_type required
Title: Operation Type
Description: Operation Type identifiers which type is this event
Type: string
Example:
CREATE
UPDATE
LIQUIDATION
INACTIVATION
EARLY_LIQUIDATION
operation_status required
Title: Operation Status
Description: Operation Status identifiers which status is this event
Type: string
Example:
CREATE
UPDATE
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Unit receivable n",
"description": "Unit receivable received",
"required": [
"merchant_document_number",
"payment_arrangement",
"settlement_date",
"acquirer_document_number",
"operation_type",
"operation_status"
],
"properties": {
"external_id": {
"type": "string",
"title": "External ID",
"description": "Identifier for a receivable unit given by the client",
"examples": [
"external-id"
]
},
"merchant_document_number": {
"type": "string",
"title": "Merchant document number",
"description": "Document number of merchant",
"examples": [
"62543463000157"
]
},
"status": {
"type": "string",
"title": "Status",
"description": "Represents the status of a processed Receivable Unit",
"examples": [
"PENDING"
]
},
"payment_arrangement": {
"type": "string",
"title": "Payment Arrangement",
"description": "Represents code of payment arrangement",
"examples": [
"MCC"
]
},
"settlement_date": {
"type": "string",
"title": "Settlement Date",
"description": "Settlement date for payment",
"format": "date",
"examples": [
"2022-12-01"
]
},
"owner_document_number": {
"type": "string",
"title": "Owner Document Number",
"description": "Document number of owner",
"examples": [
"20481714000176"
]
},
"composed_value": {
"type": "number",
"title": "Composed Value",
"description": "Represents the composed value to pay",
"format": "double",
"examples": [
10.0
]
},
"retained_composed_value": {
"type": "number",
"title": "Retained Composed Value",
"description": "Represents the retained composed value to pay",
"format": "double",
"examples": [
10.0
]
},
"blocked_value": {
"type": "number",
"title": "Blocked Value",
"description": "Represents the blocked value",
"format": "double",
"examples": [
10.0
]
},
"acquirer_document_number": {
"type": "string",
"title": "Acquirer Document Number",
"description": "Acquirer document number",
"examples": [
"20481714683595"
]
},
"payments": {
"type": "array",
"title": "List of payments",
"items": {
"$ref": "#/definitions/payments"
}
},
"message": {
"type": "string",
"title": "Error message",
"description": "Message refers to the process of failure when trying to update Receivable Unit",
"examples": [
"Receivable Unit not found",
"Unit Receivable Create Success"
]
},
"operation_type": {
"type": "string",
"title": "Operation Type",
"description": "Operation Type identifiers which type is this event",
"examples": [
"CREATE",
"UPDATE",
"LIQUIDATION",
"INACTIVATION",
"EARLY_LIQUIDATION"
]
},
"operation_status": {
"type": "string",
"title": "Operation Status",
"description": "Operation Status identifiers which status is this event",
"examples": [
"CREATE",
"UPDATE"
]
}
},
"definitions": {
"payments": {
"type": "object",
"title": "Payment",
"required": [
"residence_owner_document_number",
"account_type",
"ispb",
"account_number"
],
"description": "List of payments linked to Receivable Unit",
"properties": {
"residence_owner_document_number": {
"type": "string",
"title": "Residence Owner Document Number",
"description": "Document number of residence owner",
"examples": [
"20481714000176"
]
},
"account_type": {
"type": "string",
"title": "Account Type",
"description": "Represents the type of an account",
"examples": [
"CC, CD, PG, PP"
]
},
"compe_code": {
"type": "string",
"title": "COMPE Code",
"description": "COMPE Code of Institution",
"examples": [
"compe-code"
]
},
"ispb": {
"type": "integer",
"title": "ISPB",
"description": "ISPB number of Institution",
"examples": [
20481714
]
},
"branch_bank": {
"type": "string",
"title": "Branch Bank",
"description": "Represents the branch bank",
"examples": [
"branch-bank"
]
},
"account_number": {
"type": "string",
"title": "Account Number",
"description": "Represents the number of bank account",
"examples": [
"20481714000176"
]
},
"amount_to_pay": {
"type": "number",
"title": "Amount to Pay",
"description": "Represents the amount value to pay",
"format": "double",
"examples": [
10.0
]
},
"real_settlement_date": {
"type": "string",
"title": "Real Settlement Date",
"description": "Real settlement date for payment",
"format": "date",
"examples": [
"2022-12-01"
]
},
"real_settlement_value": {
"type": "number",
"title": "Real Settlement value",
"description": "Real settlement value",
"format": "double",
"examples": [
10.0
]
}
}
}
}
}
{
"external_id": "external-id",
"merchant_document_number": "62543463000157",
"status": "PENDING",
"payment_arrangement": "MCC",
"settlement_date": "2022-12-01",
"owner_document_number": "20481714000176",
"composed_value": 10.0,
"retained_composed_value": 10.0,
"blocked_value": 10.0,
"acquirer_document_number": "20481714683595",
"payments": {
"residence_owner_document_number": "20481714000176",
"account_type": "CC, CD, PG, PP",
"compe_code": "compe-code",
"ispb": 20481714,
"branch_bank": "branch-bank",
"account_number": "20481714000176",
"amount_to_pay": 10.0,
"real_settlement_date": "2022-12-01",
"real_settlement_value": 10.0
},
"message": "Receivable Unit not found",
"operation_type": "CREATE",
"operation_status": "CREATE"
}
Updated 6 days ago