Product

Create overdraft product

Create a new overdraft product.<br> The overdraft API enables a bank to set an overdraft limit for an account when the balance is insufficient. For details, refer to How overdraft works.<br> This endpoint generates an Overdraft product created event.

post/v1/overdraft

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/v1/overdraft
  • Auth
    none declared

Request body

namestring required

Overdraft product name. This name is defined by the client.

interest_plan_idstring uuid required

Interest plan ID generated during the plan's creation. Created via the Create interest plan endpoint.

processing_codestring required

Processing code for the debit transaction.

If split_transaction is false (the default), each installment payment is recorded as one debit transaction equal to the installment amount minus the discount, and processing_code is the processing code for that transaction.

If split_transaction is true, each installment payment is recorded as two transactions: a debit transaction for the installment amount and a credit transaction for the discount. In this case, processing_code is the processsing code for the debit transaction, and second_processing_code is the processing code for the credit transaction.

grace_periodinteger

Grace period during which you can restore the balance without incurring any interest charges. The unit is measured in days.

Example request

{
  "name": "Overdraft Limit 1000",
  "interest_plan_id": "b935acaf-886c-4817-8f7c-c2cc3ce4d509",
  "processing_code": "99066",
  "grace_period": 10
}

Response

Product created successfully

product_idstring uuid

Product ID generated for an overdraft product. Once this ID is created, you must link it to your account ID.

namestring

Produt name

interest_plan_idstring uuid

Interest plan ID generated during the plan's creation. Created via the Create interest plan endpoint.

grace_periodinteger

Grace period during which you can restore the balance without incurring any interest charges. The unit is measured in days.

processing_codestring

Processing code for the debit transaction.

If split_transaction is false (the default), each installment payment is recorded as one debit transaction equal to the installment amount minus the discount, and processing_code is the processing code for that transaction.

If split_transaction is true, each installment payment is recorded as two transactions: a debit transaction for the installment amount and a credit transaction for the discount. In this case, processing_code is the processsing code for the debit transaction, and second_processing_code is the processing code for the credit transaction.

status'CREATED' | 'ACTIVE' enum

Overdraft product status.<br>

  • CREATED: When you successfully created an overdraft product.
  • ACTIVE: When you attach your overdraft product to an account or a program ID. Once it's attached, the product becomes ACTIVE.
created_at_datetimestring date-time

Product created datetime. Format: YYYY-MM-DDThh:mm:ss.sss.

Example response

{
  "name": "Overdraft Limit 1000",
  "processing_code": "99066"
}

Changes

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