Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Close account cycle

Close account cycle

Close cycle for a specific account.

post/v1/accounts/{accountId}/statement-close

Path parameters

accountIdinteger required
Example:6912345

Account ID

Headers

x-tenantstring required

Tenant ID

x-cidstring

The Correlation Identifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header of an API endpoint call. If the x-cid value isn't passed, one is automatically generated.

Request body

tracking_idstring required

Customer created tracking ID. Must consist of alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), and colons (:), with a length from 1 to 128. The Pismo platform uses this field to implement idempotency and prevent duplicates.

Example request

{
  "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c"
}

Response

OK

cycle_closing_request_idinteger

ID generated for the request by the Pismo platform

account_idinteger

Account ID

current_statement_idinteger

ID of current statement

tracking_idstring

Customer created tracking ID. Must consist of alphanumeric characters (a-z, A-Z, 0-9), hyphens (-), and colons (:), with a length from 1 to 128. The Pismo platform uses this field to implement idempotency and prevent duplicates.

created_atstring date-time

Datetime program calendar strategy was created. Format = YYYY-MM-DDTHH:MM:SS:MM.

status'PENDING' | 'CYCLE_CLOSING_REQUESTED' | 'ERROR'

Online cycle closing status. Possible values are [PENDING, CYCLE_CLOSING_REQUESTED, ERROR].

Example response

{
  "cycle_closing_request_id": 365,
  "account_id": 6912345,
  "current_statement_id": 325632587,
  "tracking_id": "3368328d-e4c6-4c75-99a9-9d59f3501d8c",
  "created_at": "2024-09-12T16:46:16.43663522",
  "status": "PENDING"
}