Skip to content

Create A Proposal

Create A Installments Proposal

HTTP Request

POST /v1/payments/proposals

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "amount": 100000,
    "country": "CO",
    "currency": "COP",
    "installmentPlanId": "2daac1cf-40f0-4311-9114-fb7e10e5f682"
}
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}}

Request Body Parameters

Parameter Required 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.
#### 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.

Create A Credit Card Payment With Installments

To create a payment with installments, first you need to contact us to create an Installments Plan, and then you need to create an Installments Proposal, to get the installments details and create a payment with installments.

With the Installment Proposal ID(proposalId) and the number of installments(installments), you can go ahead and create a payment with installments.

HTTP Request

POST /v1/payments/charges/card

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Request Body
{
    "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "amount": 100000,
    "currency": "USD",
    "country": "CO",
    "paymentMethod": "CREDIT_CARD",
    ...  # other basic request fields
    "paymentProposalInfo": {
        "proposalId": "beb199db-fb9c-481b-a951-73b905d5ce43"
    },
    "installments": 3,
    ...  # other basic request fields
}
Response
{
    "transferStatusCode": 200,
    "idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "referenceId": "1ec983fa-1a37-679b-809b-067861d87ab0",
    "paymentMethod": "CREDIT_CARD",
    "amount": 100000,
    "currency": "USD",
    "finalAmount": 593606,
    "finalCurrency": "COP",
    "country": "CO",
    ...  # other basic response fields
    "amountDetails": {
        "taxAmountDetails": [
            {
                "taxRate": {
                    "rate": 0.0038,
                    "type": "CO_IOF_FX_TAX"
                },
                "amount": 2043
            }
        ],
        "fxAmountDetails": {
            "fxRate": {
                "base": "USD",
                "target": "COP",
                "timestamp": 1664443743,
                "exchangeRate": 5.37599
            },
            "baseAmount": 100000,
            "targetAmount": 537599
        },
        "installmentAmountDetails": {
            "installmentAmount": 49467,
            "installments": 3,
            "totalAmount": 593606
        }
    }
}

HTTP Headers Details

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

Request Body Parameters

Parameter Required Type Description
paymentProposalInfo JSON The payment installment proposal info. Required if create a payment with installments.
installments Integer Number of installments. Required if create a payment with installments.

Response Body Parameters

Parameter Type Description
amountDetails JSON The payment installments amount details.

Object Parameters

paymentProposalInfo
Parameter Required Type Description
proposalId String The installment proposal ID. Required if create a payment with installments.
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.
taxAmountDetails
Parameter Type Description
taxRate JSON The tax rate details.
amount Long The tax amount.
fxAmountDetails
Parameter Type Description
fxRate JSON The foreign exchange rate details.
baseAmount Long The amount of base currency.
targetAmount Long The amount of target currency.
installmentAmountDetails
Parameter Type Description
installmentAmount Long Installment amount.
installments Integer Number of installments.
totalAmount Long Installments total amount.
taxRate
Parameter Type Description
rate Positive Float Tax rate.
type String Tax type.
fxRate
Parameter Type Description
base String Base currency, e.g. USD
target String Target currency, e.g. COP
timestamp Long The timestamp when exchanging currency.
exchangeRate Positive Float The exchange rate.
Back to top