balance-discharge-1
This event is generated when a credit transaction is used to discharge debt. The event is generated for each discharge, so a single credit transaction could result in multiple discharge-1
events.
Type: object
Domain: balance
Event: discharge
Version: 1
transaction_id required
Description: Credit transaction ID
Type: integer
Example:
60659309
statement_id required
Description: Transaction's statement ID
Type: integer
Example:
100002556
transaction_amount required
Description: Credit transaction total amount
Type: number
Example:
240.48
transaction_type_id required
Description: Credit transaction type ID
Type: integer
Example:
201
customer_id
Description: Customer ID
Type: integer or null
Example:
5217323
account_id required
Description: Account ID
Type: integer
Example:
5106089
program_id required
Description: Program ID
Type: integer
Example:
252
program_type_id required
Description: Credit transaction program type ID
Type: integer
Example:
1
event_datetime required
Description: Event date and time in ISO 8601 format
Type: string
Format: date-time
Example:
2020-07-06T05:09:33Z
target
Description: Debit transactions discharged by the credit transaction
Type: array
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Credit transaction used for discharge",
"description": "This event is generated when a credit transaction is used to discharge debt. The event is generated for each discharge, so a single credit transaction could result in multiple `discharge-1` events.",
"properties": {
"transaction_id": {
"type": "integer",
"description": "Credit transaction ID",
"examples": [
60659309
]
},
"statement_id": {
"type": "integer",
"description": "Transaction's statement ID",
"examples": [
100002556
]
},
"transaction_amount": {
"type": "number",
"description": "Credit transaction total amount",
"examples": [
240.48
]
},
"transaction_type_id": {
"type": "integer",
"description": "Credit transaction type ID",
"examples": [
201
]
},
"customer_id": {
"type": [
"integer",
"null"
],
"description": "Customer ID",
"examples": [
5217323
]
},
"account_id": {
"type": "integer",
"description": "Account ID",
"examples": [
5106089
]
},
"program_id": {
"type": "integer",
"description": "Program ID",
"examples": [
252
]
},
"program_type_id": {
"type": "integer",
"description": "Credit transaction program type ID",
"examples": [
1
]
},
"event_datetime": {
"type": "string",
"description": "Event date and time in ISO 8601 format",
"format": "date-time",
"examples": [
"2020-07-06T05:09:33Z"
]
},
"target": {
"$ref": "#/definitions/target"
}
},
"definitions": {
"target_item": {
"type": "object",
"properties": {
"transaction_id": {
"type": "integer",
"description": "Debit transaction ID",
"examples": [
28318254
]
},
"statement_id": {
"type": "integer",
"description": "Transaction's statement ID",
"examples": [
100002556
]
},
"transaction_type_id": {
"type": "integer",
"description": "Debit transaction type ID",
"examples": [
112
]
},
"customer_id": {
"type": [
"integer",
"null"
],
"description": "Debit transaction customer ID",
"examples": [
5217323
]
},
"account_id": {
"type": "integer",
"description": "Debit transaction account ID",
"examples": [
5106089
]
},
"transaction_amount": {
"type": "number",
"description": "Debit transaction total amount",
"examples": [
118.9
]
},
"amount": {
"type": "number",
"description": "Debit transaction discharge amount",
"examples": [
118.9
]
},
"previous_balance": {
"type": "number",
"description": "Debit transaction previous balance before discharge",
"examples": [
118.9
]
},
"final_balance": {
"type": "number",
"description": "Debit transaction final balance after discharge",
"examples": [
0.0
]
}
},
"required": [
"transaction_id",
"statement_id",
"transaction_type_id",
"account_id",
"transaction_amount",
"amount",
"previous_balance",
"final_balance"
]
},
"target": {
"type": "array",
"description": "Debit transactions discharged by the credit transaction",
"items": {
"$ref": "#/definitions/target_item"
}
}
},
"required": [
"transaction_id",
"statement_id",
"transaction_amount",
"transaction_type_id",
"account_id",
"program_id",
"program_type_id",
"event_datetime"
]
}
Updated 13 days ago