APIs
Sub-processorsAbout PismoContact us

Migrate on-us authorizations

post
https://gw-pci.pismolabs.io/migrations/v1/migrations/on-us-authorizations

Start migration of on-us authorizations to the Pismo platform. (An on-us authorization is one that Pismo processes without involving card networks, such as Mastercard or Visa).

This endpoint generates the following events:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Start migration of on-us authorization data to the Pismo platform

migration
object
required

Additional migration details

string

Alphanumeric code generated in an authorization request and assigned to the authorization response.

string

Possible platform-generated response codes returned after authorization is processed. 00—Successfully authorized 01—Account not permitted 02—Processing code not permitted 03—Authorization denied by flex controls 04—Insufficient funds 05—Authorization denied by anti-fraud system 06—Action not permitted 98—Request error 99—Internal platform error

float

Total authorized amount, including fees

string

Requested authorization currency code (ISO 4217)

date-time

Original authorization date (UTC). Format = YYYY-MM-DDThh:mm:ssZ

string

Authorized transaction converted to the target currency. This is either a 3-character alphabetic or numeric operation currency code (ISO-4217).

string

Method used to capture card data during the authorization process. This field is REQUIRED for OnUs transactions. Values typically include: 01—Chip 02—Magnetic stripe read 05—Manual entry

float

Authorization amount in local currency

integer

Total number of installments related to the migrated authorization

date-time

Payment date and time (UTC). Determines eligibility for time-based cancellations. Format = yyyy-MM-ddTHH:mm:ssZ

number

Total authorized amount (excluding fees)

string

Pismo processing code (custom alphanumeric identifier that defines how the 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.

Note: Check that your computer is already parameterized on the platform before sending the authorization.

string

ID you provide for authorizations

This field is REQUIRED to guarantee the idempotency of a request. Requests that use the same tracking_id are considered the same. If tracking_id is not passed, each request is treated as a new one.

A tracking ID is also used after migration for cancellations and confirmations.

string

Code for a denied authorization. This is REQUIRED if the authorization is denied.

int64

Authorization status identifier: 1—TO BE PROCESSED 2—PROCESSED 3—DENIED 4—CANCELED 6—CANCEL AUTHORIZATION 7—PRE-AUTHORIZATION

string

Record ID for card migration. This is the ID for private label cards.

Note: Using PCI or any other sensitive personal data for migration ID poses serious security risks. This includes a document number, PAN, or telephone number. For enhanced security, use a hash for this field (SHA-256 with salt is recommended).

string

Custom response code for the authorization such as FL1 for referral authorization

string

Authorization description

string

ID of the installment plan used to calculate this purchase

installments_details
array of objects

Details about each installment related to the authorization that is being migrated.

installments_details
ledger_impact
array of strings
deprecated

Limits impacted by the ledger during the authorization

Note: This is a legacy field. Use the ledger_updates array instead.

ledger_impact
int64

Marketplace ID associated with the merchant

string
length ≤ 60

Merchant ID associated with the authorization (in case it was not created via migration)

metadata
object

Any valid JSON (free-form field) formatted as a JSON object using any key-value pairs.

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.

string

Identifies the type of authorization being migrated. Either authorization, cancellation, or confirmation request. 0100—Authorization 0400—Cancellation 0202—Confirmation

string
enum

Card network used in the authorization (such as VISA, MASTERCARD, or ELO)

Allowed:
string

Card network authorization code sent when a card payment has been approved.

A NSU (Network Settlement Utility) tracks the flow of funds between parties involved in a payment card transaction. Different payment card networks could have their own NSU systems. For example, Visa has VisaNet, Mastercard has BankNet, or it could be a third-party network.

string

Pass this field if the authorization is a cancellation. The value must be the cancelled purchase's original migration ID.

string

POS terminal ID (TID) associated with the merchant; identifies where an authorization is processed

string

Network transaction ID

boolean
Defaults to false

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.

Responses
202

Accepted

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?