Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Export and import

Export programs

Exports one or more programs to a ZIP file.

This endpoint starts an async export process. When that process is done, the program status, for each exported program, changes to SUCCESS.

To download the exported file, call the Download exported program endpoint.

post/programs/v1/programs/export/batch

Request body

export_idsProgramExportID[] required

Example request

{
  "export_ids": [
    1,
    2
  ]
}

Response

Created

idinteger

Program export ID

program_idnumber

Pismo program ID.

program_namestring

Program name

program_type_idinteger

Program type ID:<br />

1 = CREDITO<br />
2 = PRE-PAGO<br />
3 = DEBITO<br />
5 = MERCHANT<br />
7 = CREDITO ZERO-BALANCE<br />
8 = PRE-PAGO ZERO-BALANCE<br />
9 = DEBITO ZERO-BALANCE<br />
11 = CURRENT ACCOUNTS<br />
12 = INTERNAL ACCOUNTS<br />
13 = CORRESPONDENT ACCOUNTS<br />
15 = VOUCHER<br />

For more information, refer to Program types.

status'PENDING' | 'PROCESS' | 'SUCCESS' | 'ERROR'

Program exporter status

detailsstring

Program exporter details

file_urlstring

File URL for download export

started_atstring

Program export creation datetime. Format = yyyy-mm-ddThh:mm:ss.

finished_atstring

Datetime when program export finished. Format = yyyy-mm-ddThh:mm:ss.

userstring

User who created the export's email address

Example response

[
  {
    "id": 1,
    "program_id": 1010,
    "program_name": "Digital wallet program",
    "program_type_id": 1,
    "status": "SUCCESS",
    "details": "Details of program export 484",
    "file_url": "export/TN-00001/484/export.json",
    "started_at": "2023-07-10 15:30:14",
    "finished_at": "2023-07-10 18:31:18",
    "user": "example@pismo.io"
  }
]