Sign in
Product

Get overdraft product

Get details of a specific overdraft product.

get/v1/overdraft/{productId}

Path parameters

productIdstring uuid required

Overdraft product ID

Response

Get product details successful

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