Transaction migration started
Event generated when an transaction migration is started. Contains the payload with the data to be migrated.
Type: object
Additional properties: true
Domain: migration
Event: transaction_incoming
Version: 1
entity required
Description: Transaction's Entity
Type: object
Additional properties: true
Example:{ "migration": { "id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21", "account_id": "account-migration-id", "version_date": "2021-09-13T19:54:41Z", "statement_id": "statement-migration-id", "card_id": "card-migration-id" }, "type": "INSTALLMENTS", "processing_code": "00", "processing_descriptor": "purchase", "transaction_type": { "id": 314, "external_id": "client_id" }, "network": "VISA", "network_transaction_identifier": "tid", "merchant_id": "CARD ACCEPTOR", "merchant_city": "CITY NAME", "merchant_name": "Merchant Brand", "merchant_category_code": 742, "merchant_state_or_country": "BR", "retrieval_reference_number": "130720000148", "clearing_date": "2019-12-11", "number_of_installments": 5, "installment": 2, "accounting_date": "2019-12-11", "soft_descriptor": "WELLMART NYC 2/4", "settlement_currency_rate": 12.55, "cardholder_currency_rate": 12.6, "cardholder_amount": 12.6, "cardholder_currency_code": "840", "interest_rate": 12.31, "interest_amount": 12.42, "iof_amount": 1.55, "external_id": "1231231-123123-12312", "authorization_code": "444", "installments_type": "WITH_INTEREST", "payment_agreement": true, "payment_agreement_data": { "statement_agreement": true, "compulsory": false, "settle_accrual": false, "split_iof": false, "use_original_rate": false }, "amount": [ { "type": "PRINCIPAL", "currency": "USD", "value": "2.55" }, { "type": "LOCAL", "currency": "USD", "value": "2.5" }, { "type": "SETTLEMENT", "currency": "USD", "value": "3.5" } ], "metadata": { "key1": "value1", "key2": "value2" } }migration required
Description: The Transaction's Migration Data
Type: object
Additional properties: true
Example:{ "id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21", "account_id": "account-migration-id", "version_date": "2021-09-13T19:54:41Z", "statement_id": "statement-migration-id", "card_id": "card-migration-id" }id required
Description: Transaction's Migration Identifier
Type: string
Example:
5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21account_id required
Description: Transaction's Account Migration Identifier
Type: string
Example:
account-migration-idversion_date required
Description: Transaction's Migration's Version
Type: string
Format: date-time
Example:
2021-09-13T19:54:41Zstatement_id required
Description: Transaction's Statement Migration Identifier
Type: string
Example:
statement-migration-idcard_id required
Description: Transaction's Card Migration Identifier
Type: string
Example:
statement-migration-idauthorization_id
Description: Transaction's Authorization Migration Identifier
Type: string
Example:
authorization-migration-idtype required
Description: The Transaction's type. One of (BILLED, TO_BE_BILLED, INSTALLMENTS, ADJUSTMENT)
Type: string
Must be one of the following:
BILLED
TO_BE_BILLED
INSTALLMENTS
ADJUSTMENT
Example:
INSTALLMENTSprocessing_code
Description: The Transaction's Processing Code schema
Type: string
Example:
00processing_descriptor
Description: The Transaction's Processing Descriptor schema
Type: string
Example:
compratransaction_type
Description: Transction's Type
Type: object
Additional properties: true
Example:{ "id": 314, "external_id": "client_id" }id required
Description: Transaction's Type PISMO Identifier
Type: integer
Example:
314external_id required
Description: Transaction's Type CLIENT Identifier
Example:
client_idnetwork
Description: Transaction's NETWORK
Type: string
Example:
VISAauthorization_code
Description: Transaction's Authorization Code. It is usually an alphanumeric code that's unique among transactions associated to the same card.
Type: string
Example:
444network_transaction_identifier
Description: Represents the original transaction ID that was provided by the card network. This enables the platform to retrieve the corresponding network authorization during the migration process
Type: string
Example:
tidmerchant_id
Description: Transaction's Merchant Identifier
Type: string
Example:
CARD ACCEPTORmerchant_city
Description: Transaction's Merchant City
Type: string
Example:
CITY NAMEmerchant_name
Description: Transaction's Merchant Name
Type: string
Example:
Merchant Brandmerchant_category_code
Description: Transaction's Merchant category code
Type: integer
Example:
742merchant_state_or_country
Description: Transaction's Merchant State or Country
Type: string
Example:
BRretrieval_reference_number
Description: Transaction's Retrieval Reference Number
Type: string
Example:
130720000148clearing_date
Description: Transaction's Clearing Date
Type: string
Format: date
Example:
2019-12-11number_of_installments
Description: Transaction's Number of Installments
Type: integer
Example:
5installment
Description: Transaction's current Installment number
Type: integer
Example:
2accounting_date
Description: Transaction's Merchant Accounting Date
Type: string
Format: date
Example:
2019-12-11soft_descriptor required
Description: Transaction's Soft Descriptor
Type: string
Example:
COMPRA LOJA 1settlement_currency_rate
Description: Transaction's Settlement Currency Rate
Type: number
Example:
12.55cardholder_currency_rate
Description: Transaction's Cardholder Currency Rate
Type: number
Example:
12.6cardholder_amount
Description: Transaction's Cardholder Amount
Type: number
Example:
12.6
100cardholder_currency_code
Description: Transaction's Cardholder Currency Code
Type: string
Example:
840
986interest_rate
Description: Transaction's Interest Rate
Type: number
Example:
12.31interest_amount
Description: Transaction's Interest Amount
Type: number
Example:
12.42iof_amount
Description: Transaction's IOF Amount
Type: number
Example:
1.55status
Description: Installment Status. Valid values are: 0 - Future installment; 1 - Advancement request; 2 - Posted installment, either BILLED or TO_BE_BILLED; 4 - Advanced installment; 6 - Canceled installment
Type: string
Example:
0
1
2
4
6installments_type
Description: Installment type
Type: string
Must be one of the following:
WITHOUT_INTEREST
WITH_INTEREST
STATEMENT
Example:
WITHOUT_INTERESTcontract_id
Description: Transaction contract key
Type: string
Example:
contract-idinstallment_amount
Description: Authorization's installment amount
Type: number
Example:
12.6interest_amount_pend_approp
Description: Amount of pending interest of the installment. This value must be only used on
BILLEDandTO_BE_BILLEDtransactions when they areWITH_INTERESTotherwise the value must be zero or omitted
Type: number
Example:
12.6external_id
Description: Transaction's External Identifier
Type: string
Example:
1231231-123123-12312payment_agreement
Description: Whether a transaction is an installment or a refinancing product. Valid only when the transaction type is 'INSTALLMENTS'. Defaults to false
Type: boolean
Example:
true
falsepayment_agreement_data
Description: Data for a payment agreement transaction. Valid only when the transaction type is 'INSTALLMENTS' and payment_agreement is 'true'
Type: objectstatement_agreement required
Description: Whether the transaction is a statement agreement. Valid only when payment_agreement is true. Must be false in case compulsory is true.
Type: boolean
Example:
true
falsecompulsory required
Description: Whether the transaction is a compulsory agreement. Valid only when payment_agreement is true. Must be false in case statement_agreement is true.
Type: boolean
Example:
true
falsesettle_accrual required
Description: Whether or not the pending interest accrual must be settled (forgiven) when the agreement occurs. Valid only when payment_agreement is true.
Type: boolean
Example:
true
falsesplit_iof required
Description: When set to true, a separate transaction for IOF is generated (417).
Type: boolean
Example:
true
falseuse_original_rate required
Description: If set to true, the value from the interest_rate field is used accrued interests. Valid only when payment_agreement is true. Must be true in case compulsory is true.
Type: boolean
Example:
true
falseamount
Description: Transaction's Amount
Type: array
Additional properties: true
Example:[ { "type": "PRINCIPAL", "currency": "USD", "value": "2.55" } ]type required
Description: Transaction's Amount Type
Type: string
Example:
PRINCIPALcurrency required
Description: Transaction's Amount Currency
Type: string
Example:
USDvalue required
Description: Transaction's Amount Value
Type: string
Example:
2.55metadata
Description: Transaction's metadata
Type: object
Additional properties: true
Example:{ "key1": "value1", "key2": "value2" }
file_id
Description: The file identificator in case is using a batch file import
Type: string
Example:
accounts-1234
line_number
Description: The file line number in case is using a batch file import
Type: integer
Example:
2
origin
Description: The migration origin (FILE or API)
Type: string
Must be one of the following:
FILE
API
Example:
FILE
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://pismo.io/events/migration/transaction_incoming-1.json",
"type": "object",
"title": "Transaction migration started",
"description": "Event generated when an transaction migration is started. Contains the payload with the data to be migrated.",
"examples": [
{
"line_number": 12,
"origin": "FILE",
"entity": {
"migration": {
"id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21",
"account_id": "account-migration-id",
"version_date": "2021-09-13T19:54:41Z",
"statement_id": "statement-migration-id",
"card_id": "card-migration-id"
},
"type": "INSTALLMENTS",
"processing_code": "00",
"processing_descriptor": "purchase",
"transaction_type": {
"id": 314,
"external_id": "client_id"
},
"network": "VISA",
"network_transaction_identifier": "tid",
"merchant_id": "CARD ACCEPTOR",
"merchant_city": "CITY NAME",
"merchant_name": "Merchant Brand",
"merchant_category_code": 742,
"merchant_state_or_country": "BR",
"retrieval_reference_number": "130720000148",
"clearing_date": "2019-12-11",
"number_of_installments": 5,
"installment": 2,
"accounting_date": "2019-12-11",
"soft_descriptor": "Wellmart NYC 2/4",
"settlement_currency_rate": 12.55,
"cardholder_currency_rate": 12.6,
"cardholder_amount": 12.6,
"cardholder_currency_code": "840",
"interest_rate": 12.31,
"interest_amount": 12.42,
"iof_amount": 1.55,
"external_id": "1231231-123123-12312",
"authorization_code": "444",
"payment_agreement": true,
"payment_agreement_data": {
"statement_agreement": true,
"compulsory": false,
"settle_accrual": false,
"split_iof": false,
"use_original_rate": false
},
"amount": [
{
"type": "PRINCIPAL",
"currency": "USD",
"value": "2.55"
},
{
"type": "LOCAL",
"currency": "USD",
"value": "2.5"
},
{
"type": "SETTLEMENT",
"currency": "USD",
"value": "3.5"
}
],
"metadata": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"required": [
"entity"
],
"properties": {
"entity": {
"$id": "#/properties/entity",
"type": "object",
"description": "Transaction's Entity",
"examples": [
{
"migration": {
"id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21",
"account_id": "account-migration-id",
"version_date": "2021-09-13T19:54:41Z",
"statement_id": "statement-migration-id",
"card_id": "card-migration-id"
},
"type": "INSTALLMENTS",
"processing_code": "00",
"processing_descriptor": "purchase",
"transaction_type": {
"id": 314,
"external_id": "client_id"
},
"network": "VISA",
"network_transaction_identifier": "tid",
"merchant_id": "CARD ACCEPTOR",
"merchant_city": "CITY NAME",
"merchant_name": "Merchant Brand",
"merchant_category_code": 742,
"merchant_state_or_country": "BR",
"retrieval_reference_number": "130720000148",
"clearing_date": "2019-12-11",
"number_of_installments": 5,
"installment": 2,
"accounting_date": "2019-12-11",
"soft_descriptor": "WELLMART NYC 2/4",
"settlement_currency_rate": 12.55,
"cardholder_currency_rate": 12.6,
"cardholder_amount": 12.6,
"cardholder_currency_code": "840",
"interest_rate": 12.31,
"interest_amount": 12.42,
"iof_amount": 1.55,
"external_id": "1231231-123123-12312",
"authorization_code": "444",
"installments_type": "WITH_INTEREST",
"payment_agreement": true,
"payment_agreement_data": {
"statement_agreement": true,
"compulsory": false,
"settle_accrual": false,
"split_iof": false,
"use_original_rate": false
},
"amount": [
{
"type": "PRINCIPAL",
"currency": "USD",
"value": "2.55"
},
{
"type": "LOCAL",
"currency": "USD",
"value": "2.5"
},
{
"type": "SETTLEMENT",
"currency": "USD",
"value": "3.5"
}
],
"metadata": {
"key1": "value1",
"key2": "value2"
}
}
],
"required": [
"migration",
"type",
"soft_descriptor"
],
"properties": {
"migration": {
"$id": "#/properties/entity/properties/migration",
"type": "object",
"description": "The Transaction's Migration Data",
"examples": [
{
"id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21",
"account_id": "account-migration-id",
"version_date": "2021-09-13T19:54:41Z",
"statement_id": "statement-migration-id",
"card_id": "card-migration-id"
}
],
"required": [
"id",
"account_id",
"version_date",
"statement_id",
"card_id"
],
"properties": {
"id": {
"$id": "#/properties/entity/properties/migration/properties/id",
"type": "string",
"description": "Transaction's Migration Identifier",
"examples": [
"5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21"
]
},
"account_id": {
"$id": "#/properties/entity/properties/migration/properties/account_id",
"type": "string",
"description": "Transaction's Account Migration Identifier",
"examples": [
"account-migration-id"
]
},
"version_date": {
"$id": "#/properties/entity/properties/migration/properties/version_date",
"type": "string",
"format": "date-time",
"description": "Transaction's Migration's Version",
"examples": [
"2021-09-13T19:54:41Z"
]
},
"statement_id": {
"$id": "#/properties/entity/properties/migration/properties/statement_id",
"type": "string",
"description": "Transaction's Statement Migration Identifier",
"examples": [
"statement-migration-id"
]
},
"card_id": {
"$id": "#/properties/entity/properties/migration/properties/card_id",
"type": "string",
"description": "Transaction's Card Migration Identifier",
"examples": [
"statement-migration-id"
]
},
"authorization_id": {
"$id": "#/properties/entity/properties/migration/properties/authorization_id",
"type": "string",
"description": "Transaction's Authorization Migration Identifier",
"examples": [
"authorization-migration-id"
]
}
},
"additionalProperties": true
},
"type": {
"$id": "#/properties/entity/properties/type",
"type": "string",
"description": "The Transaction's type. One of (BILLED, TO_BE_BILLED, INSTALLMENTS, ADJUSTMENT)",
"enum": [
"BILLED",
"TO_BE_BILLED",
"INSTALLMENTS",
"ADJUSTMENT"
],
"examples": [
"INSTALLMENTS"
]
},
"processing_code": {
"$id": "#/properties/entity/properties/processing_code",
"type": "string",
"description": "The Transaction's Processing Code schema",
"examples": [
"00"
]
},
"processing_descriptor": {
"$id": "#/properties/entity/properties/processing_descriptor",
"type": "string",
"description": "The Transaction's Processing Descriptor schema",
"examples": [
"compra"
]
},
"transaction_type": {
"$id": "#/properties/entity/properties/transaction_type",
"type": "object",
"description": "Transction's Type",
"examples": [
{
"id": 314,
"external_id": "client_id"
}
],
"required": [
"id",
"external_id"
],
"properties": {
"id": {
"$id": "#/properties/entity/properties/transaction_type/properties/id",
"type": "integer",
"description": "Transaction's Type PISMO Identifier",
"examples": [
314
]
},
"external_id": {
"$id": "#/properties/entity/properties/transaction_type/properties/external_id",
"description": "Transaction's Type CLIENT Identifier",
"examples": [
"client_id"
]
}
},
"additionalProperties": true
},
"network": {
"$id": "#/properties/entity/properties/network",
"type": "string",
"description": "Transaction's NETWORK",
"examples": [
"VISA"
]
},
"authorization_code": {
"$id": "#/properties/entity/properties/authorization_code",
"type": "string",
"description": "Transaction's Authorization Code. It is usually an alphanumeric code that's unique among transactions associated to the same card.",
"examples": [
"444"
]
},
"network_transaction_identifier": {
"$id": "#/properties/entity/properties/network_transaction_identifier",
"type": "string",
"description": "Represents the original transaction ID that was provided by the card network. This enables the platform to retrieve the corresponding network authorization during the migration process",
"examples": [
"tid"
]
},
"merchant_id": {
"$id": "#/properties/entity/properties/merchant_id",
"type": "string",
"description": "Transaction's Merchant Identifier",
"examples": [
"CARD ACCEPTOR"
]
},
"merchant_city": {
"$id": "#/properties/entity/properties/merchant_city",
"type": "string",
"description": "Transaction's Merchant City",
"examples": [
"CITY NAME"
]
},
"merchant_name": {
"$id": "#/properties/entity/properties/merchant_name",
"type": "string",
"description": "Transaction's Merchant Name",
"examples": [
"Merchant Brand"
]
},
"merchant_category_code": {
"$id": "#/properties/entity/properties/merchant_category_code",
"type": "integer",
"description": "Transaction's Merchant category code",
"examples": [
742
]
},
"merchant_state_or_country": {
"$id": "#/properties/entity/properties/merchant_state_or_country",
"type": "string",
"description": "Transaction's Merchant State or Country",
"examples": [
"BR"
]
},
"retrieval_reference_number": {
"$id": "#/properties/entity/properties/retrieval_reference_number",
"type": "string",
"description": "Transaction's Retrieval Reference Number",
"examples": [
"130720000148"
]
},
"clearing_date": {
"$id": "#/properties/entity/properties/clearing_date",
"type": "string",
"description": "Transaction's Clearing Date",
"format": "date",
"examples": [
"2019-12-11"
]
},
"number_of_installments": {
"$id": "#/properties/entity/properties/number_of_installments",
"type": "integer",
"description": "Transaction's Number of Installments",
"examples": [
5
]
},
"installment": {
"$id": "#/properties/entity/properties/installment",
"type": "integer",
"description": "Transaction's current Installment number",
"examples": [
2
]
},
"accounting_date": {
"$id": "#/properties/entity/properties/accounting_date",
"type": "string",
"description": "Transaction's Merchant Accounting Date",
"format": "date",
"examples": [
"2019-12-11"
]
},
"soft_descriptor": {
"$id": "#/properties/entity/properties/soft_descriptor",
"type": "string",
"description": "Transaction's Soft Descriptor",
"examples": [
"COMPRA LOJA 1"
]
},
"settlement_currency_rate": {
"$id": "#/properties/entity/properties/settlement_currency_rate",
"type": "number",
"description": "Transaction's Settlement Currency Rate",
"examples": [
12.55
]
},
"cardholder_currency_rate": {
"$id": "#/properties/entity/properties/cardholder_currency_rate",
"type": "number",
"description": "Transaction's Cardholder Currency Rate",
"examples": [
12.6
]
},
"cardholder_amount": {
"$id": "#/properties/entity/properties/cardholder_amount",
"type": "number",
"description": "Transaction's Cardholder Amount",
"examples": [
12.6,
100
]
},
"cardholder_currency_code": {
"$id": "#/properties/entity/properties/cardholder_currency_code",
"type": "string",
"description": "Transaction's Cardholder Currency Code",
"examples": [
"840",
"986"
]
},
"interest_rate": {
"$id": "#/properties/entity/properties/interest_rate",
"type": "number",
"description": "Transaction's Interest Rate",
"examples": [
12.31
]
},
"interest_amount": {
"$id": "#/properties/entity/properties/interest_amount",
"type": "number",
"description": "Transaction's Interest Amount",
"examples": [
12.42
]
},
"iof_amount": {
"$id": "#/properties/entity/properties/iof_amount",
"type": "number",
"description": "Transaction's IOF Amount",
"examples": [
1.55
]
},
"status": {
"$id": "#/properties/entity/properties/status",
"type": "string",
"description": "Installment Status. Valid values are: 0 - Future installment; 1 - Advancement request; 2 - Posted installment, either BILLED or TO_BE_BILLED; 4 - Advanced installment; 6 - Canceled installment",
"examples": [
"0",
"1",
"2",
"4",
"6"
]
},
"installments_type": {
"$id": "#/properties/entity/properties/installments_type",
"type": "string",
"description": "Installment type",
"enum": [
"WITHOUT_INTEREST",
"WITH_INTEREST",
"STATEMENT"
],
"examples": [
"WITHOUT_INTEREST"
]
},
"contract_id": {
"$id": "#/properties/entity/properties/contract_id",
"type": "string",
"description": "Transaction contract key",
"examples": [
"contract-id"
]
},
"installment_amount": {
"$id": "#/properties/entity/properties/installment_amount",
"type": "number",
"description": "Authorization's installment amount",
"examples": [
12.6
]
},
"interest_amount_pend_approp": {
"$id": "#/properties/entity/properties/interest_amount_pend_approp",
"type": "number",
"description": "Amount of pending interest of the installment. This value must be only used on `BILLED` and `TO_BE_BILLED` transactions when they are `WITH_INTEREST` otherwise the value must be zero or omitted",
"examples": [
12.6
]
},
"external_id": {
"$id": "#/properties/entity/properties/external_id",
"type": "string",
"description": "Transaction's External Identifier",
"examples": [
"1231231-123123-12312"
]
},
"payment_agreement": {
"$id": "#/properties/entity/properties/payment_agreement",
"type": "boolean",
"description": "Whether a transaction is an installment or a refinancing product. Valid only when the transaction type is 'INSTALLMENTS'. Defaults to false",
"examples": [
true,
false
]
},
"payment_agreement_data": {
"$id": "#/properties/entity/properties/payment_agreement_data",
"type": "object",
"description": "Data for a payment agreement transaction. Valid only when the transaction type is 'INSTALLMENTS' and payment_agreement is 'true'",
"required": [
"statement_agreement",
"compulsory",
"settle_accrual",
"split_iof",
"use_original_rate"
],
"properties": {
"statement_agreement": {
"$id": "#/properties/entity/properties/payment_agreement_data/properties/statement_agreement",
"type": "boolean",
"description": "Whether the transaction is a statement agreement. Valid only when payment_agreement is true. Must be false in case compulsory is true.",
"examples": [
true,
false
]
},
"compulsory": {
"$id": "#/properties/entity/properties/payment_agreement_data/properties/compulsory",
"type": "boolean",
"description": "Whether the transaction is a compulsory agreement. Valid only when payment_agreement is true. Must be false in case statement_agreement is true.",
"examples": [
true,
false
]
},
"settle_accrual": {
"$id": "#/properties/entity/properties/payment_agreement_data/properties/settle_accrual",
"type": "boolean",
"description": "Whether or not the pending interest accrual must be settled (forgiven) when the agreement occurs. Valid only when payment_agreement is true.",
"examples": [
true,
false
]
},
"split_iof": {
"$id": "#/properties/entity/properties/payment_agreement_data/properties/split_iof",
"type": "boolean",
"description": "When set to true, a separate transaction for IOF is generated (417).",
"examples": [
true,
false
]
},
"use_original_rate": {
"$id": "#/properties/entity/properties/payment_agreement_data/properties/use_original_rate",
"type": "boolean",
"description": "If set to true, the value from the interest_rate field is used accrued interests. Valid only when payment_agreement is true. Must be true in case compulsory is true.",
"examples": [
true,
false
]
}
}
},
"amount": {
"$id": "#/properties/entity/properties/amount",
"type": "array",
"description": "Transaction's Amount",
"examples": [
[
{
"type": "PRINCIPAL",
"currency": "USD",
"value": "2.55"
},
{
"type": "LOCAL",
"currency": "USD",
"value": "2.5"
}
]
],
"additionalItems": true,
"items": {
"type": "object",
"description": "Transaction's Amount Object",
"examples": [
{
"type": "PRINCIPAL",
"currency": "USD",
"value": "2.55"
}
],
"required": [
"type",
"currency",
"value"
],
"properties": {
"type": {
"$id": "#/properties/entity/properties/amount/items/anyOf/0/properties/type",
"type": "string",
"description": "Transaction's Amount Type",
"examples": [
"PRINCIPAL"
]
},
"currency": {
"$id": "#/properties/entity/properties/amount/items/anyOf/0/properties/currency",
"type": "string",
"description": "Transaction's Amount Currency",
"examples": [
"USD"
]
},
"value": {
"$id": "#/properties/entity/properties/amount/items/anyOf/0/properties/value",
"type": "string",
"description": "Transaction's Amount Value",
"examples": [
"2.55"
]
}
},
"additionalProperties": true
}
},
"metadata": {
"$id": "#/properties/entity/properties/metadata",
"type": "object",
"description": "Transaction's metadata",
"examples": [
{
"key1": "value1",
"key2": "value2"
}
],
"additionalProperties": true
}
},
"additionalProperties": true
},
"file_id": {
"$id": "#/properties/file_id",
"type": "string",
"description": "The file identificator in case is using a batch file import",
"examples": [
"accounts-1234"
]
},
"line_number": {
"$id": "#/properties/line_number",
"type": "integer",
"description": "The file line number in case is using a batch file import",
"examples": [
"2"
]
},
"origin": {
"$id": "#/properties/origin",
"type": "string",
"description": "The migration origin (FILE or API)",
"enum": [
"FILE",
"API"
],
"examples": [
"FILE"
]
}
},
"additionalProperties": true
}
{
"line_number": 12,
"origin": "FILE",
"entity": {
"migration": {
"id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21",
"account_id": "account-migration-id",
"version_date": "2021-09-13T19:54:41Z",
"statement_id": "statement-migration-id",
"card_id": "card-migration-id"
},
"type": "INSTALLMENTS",
"processing_code": "00",
"processing_descriptor": "purchase",
"transaction_type": {
"id": 314,
"external_id": "client_id"
},
"network": "VISA",
"network_transaction_identifier": "tid",
"merchant_id": "CARD ACCEPTOR",
"merchant_city": "CITY NAME",
"merchant_name": "Merchant Brand",
"merchant_category_code": 742,
"merchant_state_or_country": "BR",
"retrieval_reference_number": "130720000148",
"clearing_date": "2019-12-11",
"number_of_installments": 5,
"installment": 2,
"accounting_date": "2019-12-11",
"soft_descriptor": "Wellmart NYC 2/4",
"settlement_currency_rate": 12.55,
"cardholder_currency_rate": 12.6,
"cardholder_amount": 12.6,
"cardholder_currency_code": "840",
"interest_rate": 12.31,
"interest_amount": 12.42,
"iof_amount": 1.55,
"external_id": "1231231-123123-12312",
"authorization_code": "444",
"payment_agreement": true,
"payment_agreement_data": {
"statement_agreement": true,
"compulsory": false,
"settle_accrual": false,
"split_iof": false,
"use_original_rate": false
},
"amount": [
{
"type": "PRINCIPAL",
"currency": "USD",
"value": "2.55"
},
{
"type": "LOCAL",
"currency": "USD",
"value": "2.5"
},
{
"type": "SETTLEMENT",
"currency": "USD",
"value": "3.5"
}
],
"metadata": {
"key1": "value1",
"key2": "value2"
}
}
}
Updated 21 days ago