v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Get Installments Plan by ID

get/installments-plans/{installment_code}

Path parameters

installment_codestring required

Identifier of the installment plan.

Response

200

idstring

namestring

account_idstring[]

merchant_referencestring

{"stackTrail":"paths:/installments-plans/{installment_code}:get:responses:200:content:application/json:schema:items: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,
        "amount": {
          "currency": "USD",
          "value": "0",
          "total_value": "0"
        }
      }
    ],
    "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.886178Z",
    "updated_at": "2023-10-11T17:52:31.886178Z",
    "payment_method_type": "NU_PAY_ENROLLMENT"
  }
]