Skip to content

Retrieve A Proposal

HTTP Request

GET /v1/payments/proposals/{{proposalId}}

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Response
{
    "id": "beb199db-fb9c-481b-a951-73b905d5ce43",
    "submitTime": "2022-11-14T05:49:57.059676Z",
    "expirationTime": "2022-11-14T06:49:57.059676Z",
    "paymentIntent": {
        "amount": 100000,
        "country": "CO",
        "currency": "COP",
        "installmentPlanId": "2daac1cf-40f0-4311-9114-fb7e10e5f682"
    },
    "planDetails": {
        "installment": [
            {
                "modifierType": "RATE",
                "rate": 0.02,
                "installments": 3
            },
            {
                "modifierType": "RATE",
                "rate": 0.05,
                "installments": 6
            },
            {
                "modifierType": "RATE",
                "rate": 0.1,
                "installments": 12
            }
        ]
    },
    "proposalDetails": {
        "installmentProposalDetails": [
            {
                "installmentAmount": 183478,
                "installments": 3,
                "totalAmount": 550435
            },
            {
                "installmentAmount": 94437,
                "installments": 6,
                "totalAmount": 566624
            },
            {
                "installmentAmount": 49467,
                "installments": 12,
                "totalAmount": 593606
            }
        ]
    }
}
HTTP Headers Details
Key Value
Authorization "bearer" + " " + {{access_token}}
x-api-key {{api_key}}
PATH and Query Parameters
Parameter Type Description
proposalId String The ID of the installments proposal
Response Body Parameters
Parameter Type Description
id String The proposal ID.
submitTime String The proposal submit time.
expirationTime String The proposal expiration time.
paymentIntent JSON The payment intention.
planDetails JSON The plan details.
proposalDetails JSON The proposal details.

Object Parameters

paymentIntent
Parameter Type Description
amount Long The transfer amount, The minimum settlement granularity of the current currency, such as 100=1COP
country String The country code.
currency String The transaction currency code.
installmentPlanId String The installment plan ID.
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.
proposalDetails
Parameter Type Description
installmentProposalDetails JSON Array The installment proposal details.
installmentProposalDetails
Parameter Type Description
installmentAmount Long Installment amount.
installments Integer Number of installments.
totalAmount Long Installments total amount.
Back to top