Authorization migration

Migrate authorizations

Start authorizations migration.

This endpoint generates the following events:

post/v1/migrations/authorizations

Request

Base URL
https://gw-pci.pismolabs.io/migrations
URL
https://gw-pci.pismolabs.io/migrations/v1/migrations/authorizations
Auth
HTTP bearer

Request body

acquirer_binstring required

Authorization acquirer BIN

arqc_presenceboolean required

Is authorization ARQC (Authorization Request Cryptogram) present?

authorization_codestring required

Authorization code generated for this operation (6 alphanumeric characters, DE 38).

authorization_response_codestring required

Response code of the authorization (DE 39), such as 00 (Approved) or 51 (Insufficient Funds). This value must be a valid code for the card network.

authorization_status'PENDING' | 'PROCESSED' | 'DROPPED' | 'DECLINED' | 'CANCELLED' required

Authorization status

PENDING—Authorizations from Base I pending confirmation
PROCESSED—Base II confirmation
DROPPED—Authorization discarded if the confirmation (Base II confirmation) is not received within 10 days.
DECLINED—Authorization denied when the validation fails (response code <> 00).
CANCELLED—Canceled authorization For information about clearing (Base II) and Base I authorization, refer to Clearing/base II.

contract_amountnumber float required

Total authorization amount with fees

currency_conversion_datestring date-time required

Authorization currency conversion date. Format = YYYY-MM-DDTHH:mm:ssZ.

cvv_presenceboolean required

Is authorization CVV present?

entry_modestring required

Authorization entry mode (such as 05 - Manual entry or 02 - Magnetic stripe read).

event_date_hourstring date-time required

Local authorization date and time according to value received in flag message (DE 12 and 13 + year). Pismo accepts this value but does not adjust for time zones in reporting or other uses. To order authorizations chronologically, use event_date_hour_utc. UTC (Coordinated Universal Time) simplifies comparisons for settlement, SLA tracking, and reporting, and prevents mismatches caused by local offsets. Format = YYYY-MM-DDTHH:MM:SS.

event_date_hour_utcstring required

Authorization event UTC date and time. UTC (Coordinated Universal Time) simplifies comparisons for settlement, SLA tracking, and reporting, and prevents mismatches caused by local offsets. Format = YYYY-MM-DDTHH:MM:SSZ.

local_amountnumber float required

Local currency value (DE 04), indicating the amount the cardholder requested in the acquirer's local currency or the transaction's source location.

local_currency_codestring required

Local ISO-4217 currency code (DE 49)

mti'0100' | '0120' | '0200' | '0400' | '0420' required

Authorization ISO 8583 MTI (message type indicator): 0100—Purchase 0120—Purchase advice 0200—Debit purchase 0400—Cancellation 0420—Cancellation advice

network'VISA' | 'MASTERCARD' | 'ELO' required

Card network used in the authorization (such as Visa or Mastercard)

nsustring required

Card network-assigned Network Settlement Utility (NSU) code for approved payments. Used to track the flow of funds across payment networks such as VisaNet or BankNet.

pin_presenceboolean required

Is authorization PIN present?

postingsobject required

Posting metadata (key-value pairs) that accepts any value. Maximum size is 1000 bytes.

principal_amountnumber float required

Total authorization amount, not including fees

processing_codestring required

Authorization processing code (custom alphanumeric identifier that defines how the Pismo platform handles a certain financial operation type).

Processing codes are integral to the transactions flow on the Pismo platform. The platform uses predefined processing codes to evaluate and process operations. For more information, refer to Processing codes and transaction types.

Note: This processing code may not exactly match the DE03 (subfield 1) message from Visa, Mastercard or any other network. example: "00"

retrieval_reference_numberstring required

Authorization retrieval reference number received in flag message (DE 37)

settlement_amountnumber float required

Settlement currency amount (DE 05, destination amount). Indicates the amount transferred between the acquirer and the issuer equal to DE 04 (amount, transaction) in the settlement currency. Mastercard programs and services use U.S. dollars as the currency of settlement.

settlement_currency_codestring required

Authorization settlement currency code

track1_presenceboolean required

Is authorization magnetic stripe Track 1 data present?

track2_presenceboolean required

Is authorization magnetic stripe Track 2 data present?

transaction_identifierstring required

Unique transaction ID (refer to DE 63 for Mastercard, DE 62.2 for Visa).

Note: This field is critical for doing network reconciliations post migration. If you are migrating pending authorizations and you don't have this field, contact your Pismo representative for guidance.

update_limitboolean required

Should the authorization affect the account's credit limit?

Note: Only set this to true in specific scenarios. Before you enable this option, contact your Pismo representative for guidance.

cardholder_amountnumber float

Transaction amount billed to the cardholder in the issuer's currency (DE 06 optional).

cardholder_currency_codestring

Cardholder currency code (DE 51, cardholder), in ISO 4217 numeric code format

cardholder_currency_conversion_ratenumber float

Conversion rate between local amount and cardholder amount (the DE 10 conversion rate that the brand sends)

installment_amountnumber float

Authorization installment amount

merchant_citystring

Authorization merchant city (DE 43 city field, maximum 15 characters)

merchant_namestring

Authorization merchant name

merchant_state_or_countrystring

Merchant state or country using ISO 3166-1 alpha-2 or alpha-3 country code

merchant_category_codestring

Authorization merchant category code (MCC), a four-digit ISO 18245 number

merchant_idstring

Authorization merchant ID

metadataobject

Authorization metadata (key-value pairs) that accepts any values except PCI data. Maximum size is 1000 bytes.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

number_of_installmentsinteger

Total number of installments in the current migration authorization

pre_authorizationboolean

Is authorization a pre-authorization? On pending authorizations, this affects the time that it takes to cancel the authorization if no confirmation arrives from the network settlement file.

referral_updated_atstring date-time

Date and time when the referral was last updated. Identifies when a fraud suspicion is no longer valid. Format = YYYY-MM-ddTHH:mm:ss.

settlement_currency_ratestring

Authorization settlement currency rate

terminal_capabilitystring

Is terminal pre-authorized? Field 130 (Visa) and DE 61 (Mastercard) POS (Point Of Sale). REQUIRED for chip purchases.

token_requestor_idstring

Authorization token requestor ID

wallet_identifierstring

Authorization wallet identifier

ledger_impactstring[]

Limits impacted by the ledger during the authorization.

Note: This is a legacy field. You should use the ledger_updates array instead.

Example request

{
  "acquirer_bin": "65153141",
  "authorization_code": "R1CM3D",
  "authorization_response_code": "00",
  "authorization_status": "PENDING",
  "contract_amount": 19.9,
  "currency_conversion_date": "2021-08-11T11:25:43.56752Z",
  "entry_mode": "01",
  "event_date_hour": "2021-08-11T11:25:43",
  "event_date_hour_utc": "2021-08-11T8:25:43Z",
  "local_amount": 15.35,
  "local_currency_code": "986",
  "migration": {
    "account_id": "account-migration-id",
    "version_date": "2021-09-13T19:54:41Z",
    "card_id": "card-migration-id_1234",
    "id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21",
    "tokenization_id": "tokenization-id-2468"
  },
  "mti": "0100",
  "network": "VISA",
  "nsu": "W12345",
  "postings": {
    "key1": "value1",
    "key2": "value2"
  },
  "principal_amount": 171.42,
  "retrieval_reference_number": "664151",
  "settlement_amount": 171.42,
  "settlement_currency_code": "840",
  "transaction_identifier": "de63",
  "update_limit": true,
  "cardholder_amount": 172.42,
  "cardholder_currency_code": "840",
  "cardholder_currency_conversion_rate": 0.99,
  "installment_amount": 171.42,
  "merchant_city": "São Paulo",
  "merchant_name": "Merchant XYZ",
  "merchant_state_or_country": "RS",
  "merchant_category_code": "1011",
  "merchant_id": "xF5E0",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "number_of_installments": 2,
  "referral_updated_at": "2021-08-11T11:25:43",
  "settlement_currency_rate": "1.50000112",
  "terminal_capability": "000001100003",
  "token_requestor_id": "ZAMBAS",
  "wallet_identifier": "GOOGLE PAY",
  "ledger_impact": [
    "AVAILABLE_INSTALLMENT_LIMIT"
  ]
}

Response

Accepted

Changes

No recorded changes to this operation across all 1 revision of this API.