Installment payment processed
Event generated when an installment payment is processed
Type: object
Domain: balance
Event: installment_payment_processed
Version: 1
account_id required
Description: Advanced installment account ID
Type: integer
Example:
9832195123
event_date_time required
Description: When event sent date and time in ISO-8601 format
Type: string
Format: date-time
Example:
2021-10-18T15:23:17Z
payment_agreement_id required
Description: Payment agreement ID
Type: integer
Example:
18991
statement_agreement required
Description: Statement agreement flag
Type: boolean
Example:
true
compulsory required
Description: Is agreement compulsory flag
Type: boolean
Example:
true
split_iof required
Description: Generate IOF (Brazilian tax) transactions separetely flag
Type: boolean
Example:
true
status required
Description: Payment agreement status
Type: string
Example:
PROCESSED
created_at required
Description: Payment agreement creation date time in ISO 8601 format
Type: string
Format: date-time
Example:
2021-10-18T15:23:17Z
version required
Description: Payment agreement processor service version
Type: integer
Example:
4
metadata
Title: Metadata
Description: Additional information relevant to the customer. No business rule validation is performed on it.
Type: object
Example:{ "key1": "value1", "key2": "value2" }
credit_transaction required
Description: Credit transaction
Type: objectamount required
Description: Credit transaction amount
Type: number
Format: double
Example:
40.3transaction_id required
Description: Credit transaction ID
Type: integer
Example:
2306505transaction_type_id required
Description: Credit transaction type ID
Type: integer
Example:
122statement_id required
Description: Credit transaction statement ID
Type: integer
Example:
98132196authorization_id required
Description: Credit transaction authorization ID
Type: integer
Example:
9874151
installments required
Type: array
installment required
Description: Installment number
Type: integer
Example:
1amount required
Description: Installment amount
Type: number
Format: double
Example:
10.6principal_amount required
Description: Installment principal amount
Type: number
Format: double
Example:
12.3transaction_id required
Description: Installment transaction ID
Type: integer
Example:
123123transaction_type required
Description: Installment transaction type ID
Type: integer
Example:
2statement_id required
Description: Installment statement ID
Type: integer
Example:
298741321authorization_id required
Description: Installment authorization ID
Type: integer
Example:
85189123
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Installment payment processed",
"description": "Event generated when an installment payment is processed",
"required": [
"account_id",
"event_date_time",
"payment_agreement_id",
"statement_agreement",
"compulsory",
"split_iof",
"status",
"created_at",
"version",
"credit_transaction",
"installments"
],
"properties": {
"account_id": {
"type": "integer",
"description": "Advanced installment account ID",
"examples": [
9832195123
]
},
"event_date_time": {
"type": "string",
"description": "When event sent date and time in ISO-8601 format",
"format": "date-time",
"examples": [
"2021-10-18T15:23:17Z"
]
},
"payment_agreement_id": {
"type": "integer",
"description": "Payment agreement ID",
"examples": [
18991
]
},
"statement_agreement": {
"type": "boolean",
"description": "Statement agreement flag",
"examples": [
true
]
},
"compulsory": {
"type": "boolean",
"description": "Is agreement compulsory flag",
"examples": [
true
]
},
"split_iof": {
"type": "boolean",
"description": "Generate IOF (Brazilian tax) transactions separetely flag",
"examples": [
true
]
},
"status": {
"type": "string",
"description": "Payment agreement status",
"examples": [
"PROCESSED"
]
},
"created_at": {
"type": "string",
"description": "Payment agreement creation date time in ISO 8601 format",
"format": "date-time",
"examples": [
"2021-10-18T15:23:17Z"
]
},
"version": {
"type": "integer",
"description": "Payment agreement processor service version",
"examples": [
4
]
},
"metadata": {
"type": "object",
"title": "Metadata",
"description": "Additional information relevant to the customer. No business rule validation is performed on it.",
"examples": [
{
"key1": "value1",
"key2": "value2"
}
]
},
"credit_transaction": {
"type": "object",
"description": "Credit transaction",
"required": [
"amount",
"transaction_id",
"transaction_type_id",
"statement_id",
"authorization_id"
],
"properties": {
"amount": {
"type": "number",
"description": "Credit transaction amount",
"format": "double",
"examples": [
40.3
]
},
"transaction_id": {
"type": "integer",
"description": "Credit transaction ID",
"examples": [
2306505
]
},
"transaction_type_id": {
"type": "integer",
"description": "Credit transaction type ID",
"examples": [
122
]
},
"statement_id": {
"type": "integer",
"description": "Credit transaction statement ID",
"examples": [
98132196
]
},
"authorization_id": {
"type": "integer",
"description": "Credit transaction authorization ID",
"examples": [
9874151
]
}
}
},
"installments": {
"type": "array",
"title": "Installments array",
"items": {
"type": "object",
"required": [
"installment",
"amount",
"principal_amount",
"transaction_id",
"transaction_type",
"statement_id",
"authorization_id"
],
"properties": {
"installment": {
"type": "integer",
"description": "Installment number",
"examples": [
1
]
},
"amount": {
"type": "number",
"description": "Installment amount",
"format": "double",
"examples": [
10.6
]
},
"principal_amount": {
"type": "number",
"description": "Installment principal amount",
"format": "double",
"examples": [
12.3
]
},
"transaction_id": {
"type": "integer",
"description": "Installment transaction ID",
"examples": [
123123
]
},
"transaction_type": {
"type": "integer",
"description": "Installment transaction type ID",
"examples": [
2
]
},
"statement_id": {
"type": "integer",
"description": "Installment statement ID",
"examples": [
298741321
]
},
"authorization_id": {
"type": "integer",
"description": "Installment authorization ID",
"examples": [
85189123
]
}
}
}
}
}
}
{
"account_id": 9832195123,
"event_date_time": "2021-10-18T15:23:17Z",
"payment_agreement_id": 18991,
"statement_agreement": true,
"compulsory": true,
"split_iof": true,
"status": "PROCESSED",
"created_at": "2021-10-18T15:23:17Z",
"version": 4,
"metadata": {
"key1": "value1",
"key2": "value2"
},
"credit_transaction": {
"amount": 40.3,
"transaction_id": 2306505,
"transaction_type_id": 122,
"statement_id": 98132196,
"authorization_id": 9874151
},
"installments": {
"installment": 1,
"amount": 10.6,
"principal_amount": 12.3,
"transaction_id": 123123,
"transaction_type": 2,
"statement_id": 298741321,
"authorization_id": 85189123
}
}
Updated 4 days ago