v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Programs

List programs

List an organization's programs. The organization ID is parsed from the token.

For information about programs and organizations, refer to Core objects.

get/programs/v1/programs

Query parameters

pageinteger
Example:1

Page number

perPageinteger
Example:15

Items per page

order'ASC' | 'DESC'

Order to return items: ASC = ascending order, DESC = descending. Default is DESC.

orderBy'ID' | 'NAME'
Example:ID

Sort by ID or NAME. Default = ID.

programIdinteger
Example:12345

Program ID

namestring

Program name filter

type'CREDITO' | 'PRE-PAGO' | 'DEBITO' | 'MERCHANT' | 'CREDITO ZERO-BALANCE' | 'PRE-PAGO ZERO-BALANCE' | 'DEBITO ZERO-BALANCE' | 'CURRENT ACCOUNTS' | 'INTERNAL ACCOUNTS' | 'CORRESPONDENT ACCOUNTS' | 'VOUCHER'

Program type:<br /> CREDITO — Full balance credit accounts<br /> PRE-PAGO — Full balance prepaid accounts<br /> DEBITO — Full balance debit accounts<br /> MERCHANT — Merchant accounts<br /> CREDITO ZERO-BALANCE — Zero balance credit accounts<br /> PRE-PAGO ZERO-BALANCE — Zero balance prepaid accounts<br /> DEBITO ZERO-BALANCE — Zero balance debit accounts<br /> CURRENT ACCOUNTS — Current accounts<br /> INTERNAL ACCOUNTS — Internal accounts<br /> CORRESPONDENT ACCOUNTS — Correspondent accounts<br /> VOUCHER - Prepaid voucher meal/food card<br />

For more information, refer to Program types.

binValuestring

Bank Identification Number (BIN) value filter. Card network-issued 6 or 8 digit value identifying the card network, issuer, and product.

Response

OK

current_pageinteger

Current page number

pagesinteger

Number of pages

per_pageinteger

Maximum number of items per page

total_itemsinteger

Total number of items

Example response

{
  "current_page": 1,
  "items": [
    {
      "id": 986
    }
  ],
  "pages": 10,
  "per_page": 15,
  "total_items": 100
}