Sign in

v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Create Installments Plan

post/installments-plans

Request body

namestring required

The installment plan name (MAX 255; MIN 3)

account_idstring[] required

The unique identifier(s) of the account(s) that will have the installment plan (UUID; 36 chars).

merchant_referencestring required

Identification of the installment plan (MAX 255; MIN 3)

country_codestring

The issuer's country (ISO 3166-1 MAX 2; MIN 2)

brandstring[]

Card’s brand information (MAX 255; MIN 3).

issuerstring

Card issuer (MAX 255; MIN 3)

iinstring[]

The issuer identification number (IIN) refers to the first few digits of a payment card number issued by a financial institution (MAX 8; MIN 6)

first_installment_deferralinteger

The amount of months to wait to debit the first installment (MAX: 3).

payment_method_type'CARD' | 'NU_PAY_ENROLLMENT'

Allows specifying the payment method type when creating an installment plan.

Response

200

idstring
namestring
account_idstring[]
merchant_referencestring
typestring
sourcestring
provider_idstring
schemestring
brandstring[]
issuerstring
issuer_idstring
{"stackTrail":"paths:/installments-plans:post:responses:200:content:application/json:schema:properties:iin","oasType":"schema","type":"unknown"}
country_codestring
first_installment_deferralinteger
created_atstring
updated_atstring
payment_method_typestring

Example response

{
  "id": "4d573425-33f9-4c46-b009-2c7e749b0ec7",
  "name": "plan_007",
  "account_id": [
    "f7c5fe77-721b-49c2-84d3-957748df3c2c"
  ],
  "merchant_reference": "Test",
  "installments_plan": [
    {
      "installment": 1,
      "rate": 1
    }
  ],
  "brand": [
    "VISA"
  ],
  "country_code": "US",
  "amount": {
    "Currency": "USD",
    "max_value": 100000000
  },
  "availability": {
    "start_at": "2023-09-12T00:00:00Z",
    "finish_at": "2030-09-20T00:00:00Z"
  },
  "created_at": "2023-10-11T17:52:31.886178246Z",
  "updated_at": "2023-10-11T17:52:31.886178246Z",
  "payment_method_type": "NU_PAY_ENROLLMENT"
}