Skip to content

Retrieve A Proposal

Use a Proposal ID to get the proposal details.

HTTP Request

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

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}",
    "x-api-key": "{{api_key}}"
}
Response
{
    "id": "3c31a13f-69a2-425d-a383-1bbd697329db",
    "submitTime": "2023-09-21T10:53:39Z",
    "expirationTime": "2023-09-21T11:53:39Z",
    "paymentIntent": {
        "amount": 100000,
        "country": "BR",
        "currency": "USD",
        "targetCurrency": "BRL",
        "installmentPlanId": "fcb50514-2124-4e89-9238-8357714f1593"
    },
    "planDetails": {
        "installment": [
            {
                "modifierType": "RATE",
                "rate": 0,
                "installments": 1
            },
            {
                "modifierType": "RATE",
                "rate": 0,
                "installments": 2
            },
            {
                "modifierType": "RATE",
                "rate": 0,
                "installments": 3
            }
        ],
        "fx": [
            {
                "base": "USD",
                "target": "BRL",
                "spreadRate": 0.02
            },
            {
                "base": "USD",
                "target": "MXN",
                "spreadRate": 0.02
            }
        ],
        "tax": [
            {
                "modifierType": "RATE",
                "rate": 0.0038,
                "type": "BR_IOF_FX_TAX"
            }
        ]
    },
    "proposalDetails": {
        "fxProposalDetails": {
            "fxRate": {
                "modifierType": "RATE",
                "base": "USD",
                "target": "BRL",
                "timestamp": 1664443743,
                "exchangeRate": 5.4835098
            },
            "baseAmount": 100000,
            "targetAmount": 548351
        },
        "installmentProposalDetails": [
            {
                "installmentAmount": 548351,
                "installments": 1,
                "totalAmount": 548351
            },
            {
                "installmentAmount": 274176,
                "installments": 2,
                "totalAmount": 548351
            },
            {
                "installmentAmount": 182784,
                "installments": 3,
                "totalAmount": 548351
            }
        ],
        "taxProposalDetails": [
            {
                "taxRate": {
                    "modifierType": "RATE",
                    "rate": 0.0038,
                    "type": "BR_IOF_FX_TAX"
                },
                "amount": 380
            }
        ]
    }
}
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 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=1BRL
country String The country code.
currency String The base currency code.
targetCurrency String The target currency code.
installmentPlanId String The installment plan ID.
taxPlanId String The tax plan ID.
planDetails
Parameter Type Description
installment JSON Array Installments plan details.
fx JSON Array fx plan details.
tax JSON Array Tax plan details.
installment
Parameter Type Description
modifierType String Modifier type. RATE
rate Positive Float Surcharge rate.
installments Integer Number of installments.
fx
Parameter Type Description
base String base currency
target String target currency
spreadRate Positive Float Foreign exchange spread rate
tax
Parameter Type Description
modifierType String Modifier type. RATE
rate Positive Float Tax rate.
type String Type of tax fee.
proposalDetails
Parameter Type Description
fxProposalDetails JSON Array The fx proposal details.
installmentProposalDetails JSON Array The installment proposal details.
taxProposalDetails JSON Array The tax proposal details.
installmentProposalDetails
Parameter Type Description
installmentAmount Long Installment amount.
installments Integer Number of installments.
totalAmount Long Installments total amount.
fxProposalDetails
Parameter Type Description
fxRate JSON The foreign exchange rate details.
baseAmount Long The amount of base currency.
targetAmount Long The amount of target currency.
fxRate
Parameter Type Description
modifierType String Modifier type. RATE
base String Base currency, e.g. USD
target String Target currency, e.g. BRL
timestamp Long The timestamp when exchanging currency.
exchangeRate Positive Float The exchange rate.
taxProposalDetails
Parameter Type Description
taxRate JSON The foreign exchange rate details.
amount Long The tax amount.
taxRate
Parameter Type Description
modifierType String Modifier type. RATE
rate Positive Float Tax rate.
type String Type of tax fee.
Back to top