v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Get Installments Plans

get/installments-plans

Query parameters

account_idstring required

The unique identifier of the account. Find it on the Yuno dashboard (UUID; 36 chars).

currencystring

Currency used for filtering plans (ISO 4217; 3 chars).

iinstring

[Optional] - 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). In case you defined an iin for the installments plan, you can use it to filter the response.

amountstring

[Optional] - The amount that the installment plan is available for. In case you defined an amount range for the installments plan, you can use it to filter the response.

payment_method_typestring

[Optional] - Filter by payment method type (CARD | NU_PAY_ENROLLMENT).

Response

200

idstring

namestring

account_idstring[]

merchant_referencestring

{"stackTrail":"paths:/installments-plans: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"
  }
]