Copy program (async)

post

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

Copy an existing program to create a new one.

Refer to Core objects for more information about programs.

For information on what properties are copied, refer to Cloned and exported program properties.

This endpoint operates asynchronously; meaning, your program can continue executing while the program is being copied. It can take 2 minutes or more to copy the program.

Alternatively, you can call Copy program, which executes synchronously and returns a response indicating failure or success.

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

Program copy body request

base_program_id

int64

required

ID of program that was used to create this program.

name

string

required

length ≤ 50

Program name

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.

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

brand

string

enum

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

Allowed:

bin

object

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

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

Copy program (async)

Changelog

Support

Pismo is here to help

201OK

400Bad Request

404Not Found

500Internal Server Error