Skip to content

Retrieve Plans

Get an installments plan by plan ID

HTTP Request

GET /v1/payments/plans/{{planId}}

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Response
{
    "id": "UUID",
    "type": "INSTALLMENT",
    "planDetails": {
        "installment": [
            {
                "modifierType": "RATE",
                "rate": 0.02,
                "installments": 3
            },
            {
                "modifierType": "RATE",
                "rate": 0.05,
                "installments": 6
            },
            {
                "modifierType": "RATE",
                "rate": 0.1,
                "installments": 12
            }
        ]
    }
}

HTTP Headers Details

Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

PATH and Query Parameters

Parameter Type Description
planId String The ID of the installments plan

Response Body Details

Parameter Type Description
id String The plan ID, an UUID
type String Type of the plan. INSTALLMENT
planDetails JSON The plan details.

List all installments plans

HTTP Request

GET /v1/payments/plans

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Response
[
    {
        "id": "UUID",
        "type": "INSTALLMENT",
        "planDetails": {
            "installment": [
                {
                    "modifierType": "RATE",
                    "rate": 0.02,
                    "installments": 3
                },
                {
                    "modifierType": "RATE",
                    "rate": 0.05,
                    "installments": 6
                },
                {
                    "modifierType": "RATE",
                    "rate": 0.1,
                    "installments": 12
                }
            ]
        }
    }
]

HTTP Headers Details

Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}

Response Body Details

Parameter Type Description
- JSON Array JSON array of installments plans.

Object Parameters

JSON Array Object
Parameter Type Description
id String The plan ID, an UUID
type String Type of the plan. INSTALLMENT
planDetails JSON The plan details.
planDetails
Parameter Type Description
installment JSON Array Installments plan details.
installment
Parameter Type Description
modifierType String Modifier type. RATE
rate Positive Float Surcharge rate.
installments Integer Number of installments.
Back to top