Create program (async)

post

https://sandbox.pismolabs.io/programs/v2/programs/template

Create a program asynchronously.

For more information about programs, refer to Core objects.

This endpoint creates a program asynchronously; meaning, your app can continue executing during this. It could take 2 minutes or more for the platform to finish creating the program. Alternatively, you can use the Create program endpoint, which executes synchronously and throws an error if the program cannot be created.

This endpoint generates a Program created event. Given that creation is done asynchronously, it is recommended you do not try to access the program object via Pismo endpoints until this event is received.

To get your Organization's programs, call the List programs endpoint, or view them in the Pismo Control Center.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create program from template request

name

string

required

length ≤ 50

Program name

type

string

enum

required

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

For more information, refer to Program types

timezone

string

required

Program timezone. This is the IANA (Internet Assigned Numbers Authority) time zone database "Region/City" format.

currency_numeric_code

string

required

Program ISO 4217 currency code.

country_code

string

required

ISO 3166 Alpha-3 program country code. For example, BRA = Brazil.

bin

object

Bank Identification Number (BIN) object. REQUIRED for card-issuing programs.

brand

string

enum

Program's card brand. REQUIRED for card-issuing programs.

Allowed:

due_dates

array of objects

Array of available program due dates. Every program account specifies a due date to use.

A due date is REQUIRED for Full balance credit programs.

For each due date, day and active are REQUIRED, as in the following example:

{
    "due_dates": [
          {
            "day": 1,
            "active": true
          },
          {
            "day": 2,
            "active": false
          }
    ]
}

Note: The due date ID is passed as a numeric value. For example, for due date 1 (first day of the month) the ID could be something like 3063. This is the value you should use. day must be between 1 and 28.

due_dates

language

string

enum

Program Language:

en-US - US English
pt-BR - Brazilian Portuguese

Default is en-US

Allowed:

cycle_closing

string

Program cicle closing.

This field is used for things like accrual basis, interest calculation, taxes, penalties, tiers, and more.

Format = HH:MM:SS. Default is null.

holiday_calendar_id

string

length ≤ 36

Program holiday calendar ID

Responses

Create program (async)

Changelog

Support

Pismo is here to help

201OK

400Bad Request

404Not Found

500Internal Server Error