PIpismo
Transaction shift

Shift transactions

Shift one or more transactions between open statements. For example, a transaction can be moved from a future statement to an earlier open statement. A transaction can also be moved to a statement farther in the future. A maximum of 24 shifts are allowed per request.

This endpoint generates an Transaction updated event for each transaction that is shifted. After all the transactions are successfully shifted, it generates a Transactions shifted event.

Note: This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

post/statements-v2/v1/accounts/{accountId}/transactions/shifts

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v1/accounts/{accountId}/transactions/shifts
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:101

Account ID

Request body

tracking_idstring

Tracking identifier. Must consist of the characters [a-z,A-Z,0-9,-,:] with a range from 1 to 128. If a client clicks the button more than once when sending the command to shift transactions, the Pismo platform could create duplicate requests. The tracking identifier enables the platform to identify duplicates and ignore them.

Example request

{
  "tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2,",
  "shifts": [
    {
      "transaction_id": 10,
      "new_statement_id": 5
    },
    {
      "transaction_id": 11,
      "desired_cycle_date": "2023-12-25"
    }
  ]
}

Response

OK - Indicates that the server accepted the request and created the resource.

transaction_statement_shift_idinteger

ID of the shift operation performed

desired_cycle_datestring date

The desired cycle date. This is only present if the shift for the transaction is based on the cycle date. Format is yyyy-mm-dd.

tracking_idstring

Tracking identifier. Must consist of the characters [a-z,A-Z,0-9,-,:] with a range from 1 to 128. If a client clicks the button more than once when sending the command to shift transactions, the Pismo platform could create duplicate requests. The tracking identifier enables the platform to identify duplicates and ignore them.

Example response

{
  "transaction_statement_shift_id": 211452,
  "desired_cycle_date": "2023-12-25",
  "tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2",
  "shifts": [
    {
      "tracking_id": "3ea22692-a209-11eb-89a2-f73e179dcbc2,",
      "shifts": [
        {
          "transaction_id": 10,
          "new_statement_id": 5
        },
        {
          "transaction_id": 11,
          "desired_cycle_date": "2023-12-25"
        }
      ]
    }
  ]
}

Changes

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