Sign in

v1

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

Export program

Export a program to a JSON file.

While this endpoint returns an immediate response, it also kicks off an asynchronous export process. You can check its progress with the Get program export record endpoint. When done, the program status changes to SUCCESS.

To download the exported file, call Download exported program.

post/programs/v1/programs/export

Request body

program_idnumber required

Pismo program ID.

Example request

{
  "program_id": 1010
}

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"
}