PIpismo
Statement migration

Migrate statements

Start migration of statements.

This endpoint generates the following events:

post/v1/migrations/statements

Request

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

Headers

Authorizationstring required

JSON Web Token (JWT). Tokens expire quickly, which can result in an Unauthorized message. For more information on authentication best practices, refer to Basic authentication with client credentials.

Request body

cycle_closing_datestring date

Cycle closing date

best_transaction_daystring date

Day of best transaction. This is the cycle closing date of a credit card account. For purchases made after the cycle closes, payment is due in the next statement.

due_datestring date

Due date

real_due_datestring date

If a due date falls on a nonbusiness day, such as weekend or a holiday, the actual due date is the next business day on which the payment can be made. (Otherwise, it's the same as the due date.) Interest isn't charged until the real due date.

previous_balancenumber float

Value of previous balance

debitsnumber float

Total debits of statement

creditsnumber float

Total credits of statement

current_balancenumber float

Current balance

minimum_paymentnumber float

Minimun payment

posted_datestring date-time

Posted date

posted_fineboolean

Is fine posted?

metadataobject

Statements metadata

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.

Example request

{
  "migration": {
    "id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21",
    "version_date": "2021-09-13T19:54:41Z",
    "account_id": "EXTID1001"
  },
  "cycle_closing_date": "2018-03-15",
  "best_transaction_day": "2018-03-16",
  "due_date": "2018-03-25",
  "real_due_date": "2018-03-25",
  "previous_balance": 180.52,
  "debits": 50,
  "credits": 50,
  "current_balance": 190.52,
  "minimum_payment": 20,
  "posted_date": "2021-10-25T19:54:41Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}

Response

Accepted

Changes

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