Merchant transaction created
Type: object
Domain: merchants
Event: merchant_transaction_created
Version: 1
merchant_transaction_id required
Title: The merchant transaction identifier
Description: This field identifies the merchant transaction created.
Type: null or integer
Example:
null
1
authorization_id
Title: The authorization identifier
Description: This field identifies the authorization identifier related to transaction.
Type: null or integer
Example:
null
2
original_authorization_id
Title: The original authorization identifier
Description: This field contains the original authorization identifier related to transaction.
Type: null or string
Example:
null
339920
org_operation_id required
Title: The operation identifier relate to organization
Description: This field identifies the operation related to transaction.
Type: integer
Example:
3
processing_code
Title: The processing code relate to transaction
Description: This field identifies the processing code related to transaction.
Type: string
Example:
0001234
merchant_id required
Title: The merchant identifier
Description: This field identifies the merchant related to transaction.
Type: integer
Example:
4
creditor_id required
Title: The creditor identifier
Description: This field identifies the creditor related to merchant thats requires the transaction.
Type: integer
Example:
5
marketplace_id
Title: The marketplace identifier
Description: This field identifies the marketplace related to settlement transaction.
Type: null or integer
Example:
null
6
event_date
Title: The transaction event date
Description: This field identifies the transaction event date (in UTC RFC 3339 format).
Type: null or string
Format: date-time
Example:
null
2021-03-25T00:00:00.000Z
scheduled_payment_date required
Title: The scheduled payment date of transaction
Description: This field identifies the scheduled payment date related to transaction.
Type: string
Format: date
Example:
2021-03-25
scheduled_payment_date_adjusted
Title: The scheduled payment date adjusted of transaction
Description: This field identifies the scheduled payment date adjusted related to transaction.
Type: null or string
Format: date
Example:
null
2021-03-25
transaction_amount required
Title: The transaction amount of transaction
Description: This field identifies the transaction amount related to transaction.
Type: number
Example:
100.0
mdr_amount
Title: The mdr amount of transaction
Description: This field identifies the transaction mdr amount related to transaction.
Type: null or number
Example:
null
null
10.0
advanced_amount
Title: The advanced amount of transaction
Description: This field identifies the transaction advanced amount related to transaction.
Type: null or number
Example:
null
null
transaction_status required
Title: The transaction status of transaction
Description: This field identifies the status of transaction.
Type: string
Min length: 1
Max length: 20
Example:
PAID
SCHEDULED
SETTLED
origin_transaction_id
Title: The identifier of original transaction related to transaction
Description: This field identifies the original transaction identifier related to transaction.
Type: null or integer
Example:
null
6
advancement_request_id
Title: The identifier of advancement request related to transaction
Description: This field identifies the advancement request related to transaction.
Type: null or integer
Example:
null
7
marketplace_creditor_operation_id
Title: The marketplace creditor operation identifier
Description: This field identifies the marketplace creditor operation of the transaction created.
Type: null or integer
Example:
null
1
installment
Title: The installment identifier
Description: This field identifies the installment of the transaction created.
Type: null or integer
Example:
null
1
number_of_installments
Title: The number of installments identifier
Description: This field identifies the number of installments of the transaction created.
Type: null or integer
Example:
null
1
mdr_tax
Title: The mdr tax amount
Description: This field identifies the mdr tax amount of the transaction created.
Type: null or number
Example:
null
1.0
transaction_fee
Title: The transaction fee identifier
Description: This field identifies the transaction fee of the transaction created.
Type: null or number
Example:
null
1.0
total_mdr
Title: The total mdr identifier
Description: This field is the sum of all the mdr amounts used in the discount calculation (mdrAmount + mdrTax...) of the created transaction.
Type: null or number
Example:
null
1.0
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "Merchant transaction created",
"required": [
"merchant_transaction_id",
"org_operation_id",
"merchant_id",
"creditor_id",
"scheduled_payment_date",
"transaction_amount",
"transaction_status"
],
"properties": {
"merchant_transaction_id": {
"$id": "#/properties/merchant_transaction_id",
"type": [
"null",
"integer"
],
"title": "The merchant transaction identifier",
"description": "This field identifies the merchant transaction created.",
"examples": [
null,
1
]
},
"authorization_id": {
"$id": "#/properties/authorization_id",
"type": [
"null",
"integer"
],
"title": "The authorization identifier",
"description": "This field identifies the authorization identifier related to transaction.",
"examples": [
null,
2
]
},
"original_authorization_id": {
"$id": "#/properties/original_authorization_id",
"type": [
"null",
"string"
],
"title": "The original authorization identifier",
"description": "This field contains the original authorization identifier related to transaction.",
"examples": [
null,
"339920"
]
},
"org_operation_id": {
"$id": "#/properties/org_operation_id",
"type": "integer",
"title": "The operation identifier relate to organization",
"description": "This field identifies the operation related to transaction.",
"examples": [
3
]
},
"processing_code": {
"$id": "#/properties/processing_code",
"type": "string",
"title": "The processing code relate to transaction",
"description": "This field identifies the processing code related to transaction.",
"examples": [
"0001234"
]
},
"merchant_id": {
"$id": "#/properties/merchant_id",
"type": "integer",
"title": "The merchant identifier",
"description": "This field identifies the merchant related to transaction.",
"examples": [
4
]
},
"creditor_id": {
"$id": "#/properties/creditor_id",
"type": "integer",
"title": "The creditor identifier",
"description": "This field identifies the creditor related to merchant thats requires the transaction.",
"examples": [
5
]
},
"marketplace_id": {
"$id": "#/properties/marketplace_id",
"type": [
"null",
"integer"
],
"title": "The marketplace identifier",
"description": "This field identifies the marketplace related to settlement transaction.",
"examples": [
null,
6
]
},
"event_date": {
"$id": "#/properties/event_date",
"type": [
"null",
"string"
],
"format": "date-time",
"title": "The transaction event date",
"description": "This field identifies the transaction event date (in UTC RFC 3339 format).",
"examples": [
null,
"2021-03-25T00:00:00.000Z"
]
},
"scheduled_payment_date": {
"$id": "#/properties/scheduled_payment_date",
"type": "string",
"format": "date",
"title": "The scheduled payment date of transaction",
"description": "This field identifies the scheduled payment date related to transaction.",
"examples": [
"2021-03-25"
]
},
"scheduled_payment_date_adjusted": {
"$id": "#/properties/scheduled_payment_date_adjusted",
"type": [
"null",
"string"
],
"format": "date",
"title": "The scheduled payment date adjusted of transaction",
"description": "This field identifies the scheduled payment date adjusted related to transaction.",
"examples": [
null,
"2021-03-25"
]
},
"transaction_amount": {
"$id": "#/properties/transaction_amount",
"type": "number",
"title": "The transaction amount of transaction",
"description": "This field identifies the transaction amount related to transaction.",
"examples": [
100.0
]
},
"mdr_amount": {
"$id": "#/properties/mdr_amount",
"type": [
"null",
"number"
],
"title": "The mdr amount of transaction",
"description": "This field identifies the transaction mdr amount related to transaction.",
"examples": [
null,
0.0,
10.0
]
},
"advanced_amount": {
"$id": "#/properties/advanced_amount",
"type": [
"null",
"number"
],
"title": "The advanced amount of transaction",
"description": "This field identifies the transaction advanced amount related to transaction.",
"examples": [
null,
0.0
]
},
"transaction_status": {
"$id": "#/properties/transaction_status",
"type": "string",
"minLength": 1,
"maxLength": 20,
"title": "The transaction status of transaction",
"description": "This field identifies the status of transaction.",
"examples": [
"PAID",
"SCHEDULED",
"SETTLED"
]
},
"origin_transaction_id": {
"$id": "#/properties/origin_transaction_id",
"type": [
"null",
"integer"
],
"title": "The identifier of original transaction related to transaction",
"description": "This field identifies the original transaction identifier related to transaction.",
"examples": [
null,
6
]
},
"advancement_request_id": {
"$id": "#/properties/advancement_request_id",
"type": [
"null",
"integer"
],
"title": "The identifier of advancement request related to transaction",
"description": "This field identifies the advancement request related to transaction.",
"examples": [
null,
7
]
},
"marketplace_creditor_operation_id": {
"$id": "#/properties/marketplace_creditor_operation_id",
"type": [
"null",
"integer"
],
"title": "The marketplace creditor operation identifier",
"description": "This field identifies the marketplace creditor operation of the transaction created.",
"examples": [
null,
1
]
},
"installment": {
"$id": "#/properties/installment",
"type": [
"null",
"integer"
],
"title": "The installment identifier",
"description": "This field identifies the installment of the transaction created.",
"minimum": 0,
"maximum": 4294967295,
"examples": [
null,
1
]
},
"number_of_installments": {
"$id": "#/properties/number_of_installments",
"type": [
"null",
"integer"
],
"title": "The number of installments identifier",
"description": "This field identifies the number of installments of the transaction created.",
"minimum": 0,
"maximum": 4294967295,
"examples": [
null,
1
]
},
"mdr_tax": {
"$id": "#/properties/mdr_tax",
"type": [
"null",
"number"
],
"title": "The mdr tax amount",
"description": "This field identifies the mdr tax amount of the transaction created.",
"minimum": -9223372036854775807,
"maximum": 9223372036854775807,
"examples": [
null,
1.0
]
},
"transaction_fee": {
"$id": "#/properties/transaction_fee",
"type": [
"null",
"number"
],
"title": "The transaction fee identifier",
"description": "This field identifies the transaction fee of the transaction created.",
"minimum": -9223372036854775807,
"maximum": 9223372036854775807,
"examples": [
null,
1.0
]
},
"total_mdr ": {
"$id": "#/properties/total_mdr",
"type": [
"null",
"number"
],
"title": "The total mdr identifier",
"description": "This field is the sum of all the mdr amounts used in the discount calculation (mdrAmount + mdrTax...) of the created transaction.",
"minimum": -9223372036854775807,
"maximum": 9223372036854775807,
"examples": [
null,
1.0
]
}
}
}
{
"merchant_transaction_id": 1,
"authorization_id": 2,
"original_authorization_id": "339920",
"org_operation_id": 3,
"processing_code": "0001234",
"merchant_id": 4,
"creditor_id": 5,
"marketplace_id": 6,
"event_date": "2021-03-25T00:00:00.000Z",
"scheduled_payment_date": "2021-03-25",
"scheduled_payment_date_adjusted": "2021-03-25",
"transaction_amount": 100.0,
"mdr_amount": 0.0,
"advanced_amount": 0.0,
"transaction_status": "PAID",
"origin_transaction_id": 6,
"advancement_request_id": 7,
"marketplace_creditor_operation_id": 1,
"installment": 1,
"number_of_installments": 1,
"mdr_tax": 1.0,
"transaction_fee": 1.0,
"total_mdr ": 1.0
}
Updated 15 days ago