Migrate transactions

post

https://gw-pci.pismolabs.io/migrations/v1/migrations/transactions

Start migration of transactions.

This endpoint generates the following events:

Transaction migration started
Transaction migration completed
Payment agreements migration completed (generated when the migration has the payment_agreement field set to true)
Instant payment transaction migration completed (generated when migration.type is INSTANT_PAYMENT)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Start migration of transactions

migration

object

required

Applicant additional migration information

soft_descriptor

string

required

length ≤ 25

Human-readable description that identifies the transaction. For an installment purchase, this usually is the merchant name, the city/state, and the installment number. For example, the value Wellmart NYC 2/4 indicates the merchant is Wellmart, the transaction was made in New York City, and it is installment 2 of 4.

type

string

enum

required

Transaction types:

BILLED—The customer has already been billed for the transaction. Debit accounts and banking transactions typically use this type.
TO_BE_BILLED—The transaction has not been billed according to the platform records. That transaction will be added to the "opened statement" of the account.
INSTALLMENTS—Represents an entire installment contract with pending future installments, including information for each individual (past or future) installment. For contracts fully in the past, it is sufficient to migrate past individual installments as BILLED or TO_BE_BILLED transactions, and the INSTALLMENTS type is not necessary.
INSTANT_PAYMENT—The transaction is an instant payment, such as a Pix payment in Brazil. This type requires an instant_payment_data object with details of the transaction. Authorization type should be BANKING.
STORED—The transaction gets allocated to a future statement.

Allowed:

authorization_type

string

enum

Type of authorized transaction you want to migrate to Pismo:

NETWORK—Network-authorized transaction, such as VISA or Mastercard
PLATFORM—Bank-authorized transaction, such as fines, fees, or adjustments
ON_US—Merchant-authorized transaction, such as private label cards used in the marketplace
BANKING—Instant-payment transaction, such as the Pix system in Brazil

Note: This parameter is REQUIRED for the following transaction types:

BILLED
TO_BE_BILLED
INSTALLMENTS
STORED

Allowed:

processing_code

string

Pismo processing code. Requires previous configuration in Pismo Control Center.

processing_descriptor

string

Pismo processing descriptor. Requires previous configuration in Pismo Control Center.

transaction_type

object

Pismo transaction type ID. Requires previous configuration in Pismo Control Center.

network

string

enum

Card network name. Required for NETWORK authorization type.

Allowed:

network_transaction_identifier

string

Card-network-provided original transaction ID (DE 63 for Mastercard, DE 62.2 for Visa). The Pismo platform uses this field to retrieve corresponding network authorization during migration process.

Note: This field is critical for performing network reconciliations after migration. If you need to migrate pending authorizations but you don't have this ID, contact your Pismo representative for guidance.

merchant_id

string

ID of the merchant accepting the card for network authorization. (Only for NETWORK authorization type.)

merchant_city

string

length ≤ 15

Merchant city (DE 43 city field, maximum 15 characters)

merchant_name

string

Merchant name. (Only for NETWORK authorization type.)

merchant_category_code

integer

ID of merchant category. (Only for NETWORK authorization type.)

merchant_state_or_country

string

Merchant state or country. (Only for NETWORK authorization type.)

retrieval_reference_number

string

Retrieval reference number. (Only for NETWORK authorization type.)

clearing_date

date

Confirmation date for clearing. Format = YYYY-MM-DD. (Only for NETWORK authorization type.)

number_of_installments

int32

≥ 1

Number of installments

is_installment

boolean

Is this transaction part of an installment contract? Set to true only if transaction type is BILLED or TO_BE_BILLED.

has_interest

boolean

Is the transaction part of an installment contract and does it have interest? Set to true only if the transaction type is BILLED or TO_BE_BILLED.

installment_transaction_type_id

integer

ID of transaction type for managing installments with flexible transaction types and processing codes

installment

integer

Installment number, starting with 1. Only for installment sent as BILLED or TO_BE_BILLED type. Not necessary to send with INSTALLMENTS type. (First installment has installment number 1.)

event_date_hour

string

Original transaction date and hour. Format = YYYY-MM-DDTHH:mm:ssZ.

due_date_hour

string

Date and time when transaction is due

accounting_date

date

Creation date of accounting record. Using the go-live date is recommended. Format = YYYY-MM-DD.

settlement_currency_rate

number

Settlement currency rate. (Only for NETWORK authorization type.)

cardholder_amount

number

Transaction's cardholder amount

cardholder_currency_code

string

Transaction's cardholder currency code

cardholder_currency_rate

number

Conversion rate between local value and cardholder value. (Only for NETWORK authorization type.)

interest_rate

number

Interest rate. When using INSTALLMENTS transaction type, this sets the interest rate for all installment contracts.

interest_amount

number

Interest amount. When using INSTALLMENTS transaction type, sets the interest amount for all installment contracts.

iof_amount

number

IOF amount (Brazil only). If the transaction did not take place in Brazil, this should be left blank.

authorization_code

string

Authorization code

amounts

array of objects

List of amounts

amounts

installments_type

string

enum

Installment type (WITHOUT_INTEREST, WITH_INTEREST, or STATEMENT). Note that you use STATEMENT to migrate payment_agreement data.

Allowed:

installments

array of objects

Installment list

installments

interest_amount_pend_approp

number

Amount of pending interest in an installment transaction. When you migrate an installment transaction that still has pending interest, you must provide the interest amount so that the Pismo platform can calculate the accruals. This value must only be used on BILLED and TO_BE_BILLED transactions when they are WITH_INTEREST. Otherwise, the value must be zero or omitted.

metadata

object

Transaction metadata

payment_agreement

boolean

Defaults to false

Is this an installment or a refinancing product? If true, the Pismo platform creates the payment_agreement entity automatically, so you do not have to call the Create payment agreement endpoint separately after transaction migration. This field only affects the INSTALLMENTS type transaction.

payment_agreement_data

object

Payment agreement data. This object only affects INSTALLMENTS type transactions and only when the payment_agreement attribute is set to true.

instant_payment_data

object

Defines specific options for instant payment transactions. REQUIRED when the transaction_type is INSTANT_PAYMENT.

Headers

Authorization

string

required

JSON Web Token (JWT). Tokens expire quickly, which can result in an Unauthorized message.

Responses

202

Accepted

Migrate transactions

Changelog

Support

Pismo is here to help

400Bad request

500Internal error