PIpismo
Due date

Save program due date

Save a program due date. Day must be between 1 and 28. (Note: Due date is required for credit full-balance program types.)

When you execute this endpoint, the Pismo platform first checks to see if the specified due date already exists. If it finds an existing due date with the same values for day and grace_period_days, it considers this a match and determines that the specified due date <b>already exists</b>. In this case, there are two possibilities.

  • If active has the same value in both the existing due date and the request, the request does nothing.
  • If active has a different value in the request, the value of active in the existing due date is updated accordingly. In other words, you can use this endpoint to activate or deactivate an existing due date. <b>Note:</b>The preferred way of updating existing due dates is to use the Update program due date endpoint.

If the platform <b>does not</b> find a match, then it creates a new due date. (Note: This means that you could end up with two due dates that have the same value for day, but different values for grace_period_days.)

post/statements-v2/v1/programs/{programId}/due-dates

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v1/programs/{programId}/due-dates
  • Auth
    HTTP bearer

Path parameters

programIdinteger required
Example:1122

Program ID

Headers

Authorizationstring required

Account token, not a regular access token. Account tokens are encoded with an account ID. Tokens can expire quickly, which can result in an Unauthorized message.

Request body

dayinteger required

Due date day index

activeboolean required

Is program due date active?

<b>Note:</b> If you set active from true to false, this just means that you are no longer able to assign the program due date to an account. Accounts that are already using the program due date continue to use it.

grace_period_daysinteger

Number of grace period days. This value overrides the value of the program parameter <b>Number of days before due date to set the closing date of the statement</b> for the specified account.

You can change the grace period days for a statement any time before its due date.

Example request

{
  "active": true,
  "day": 1,
  "grace_period_days": 5
}

Response

CREATED

program_due_date_idinteger

Program due date ID

program_idinteger

Program ID

dayinteger

Due date day index

activeboolean

Is program due date active?

<b>Note:</b> If you set active from true to false, this just means that you are no longer able to assign the program due date to an account. Accounts that are already using the program due date continue to use it.

exists_accountboolean

Does account exist?

grace_period_daysinteger

Number of grace period days. This value overrides the value of the program parameter <b>Number of days before due date to set the closing date of the statement</b> for the specified account.

You can change the grace period days for a statement any time before its due date.

Example response

{
  "program_due_date_id": 3812,
  "program_id": 1052,
  "day": 1,
  "active": true,
  "grace_period_days": 5
}

Changes

No recorded changes to this operation across all 1 revision of this API.