GET /api/v1/checkout/:uuid/metadata
This endpoint provides all the data required to prepare the checkout.
It requires an input param to define the desired product:
GET /api/v1/checkout/b3b197fa-64b0-11ec-90d6-0242ac120003/metadata?product_code=pp3Possible product_code values are: pp3, pp6, sp1
Here is an example of the response:
{
"product_code": "pp3",
"requested_fields": ["given_names", "surnames", "nin", "date_of_birth", "mobile_phone", "address", "postal_code", "city"],
"total_with_tax": 1000,
"checkboxes": [
{
"id": "sequra_privacy_policy_accepted",
"checked": false,
"required": true,
"url": "https://legal.sequra.es/politica-privacidad?financier=SeQura&locale=es&merchant%5Bname%5D=test&merchant%5Bsite%5D=",
}
],
"credit_agreement": [
{
"product": "pp3",
"apr": { "value": 7723, "string": "77,23 %" },
"interest": { "value": 0, "string": "0,00 %" },
"total_with_tax": { "value": 49000, "string": "490,00 €" },
"cost_of_credit": { "value": 2400, "string": "24,00 €" },
"cost_of_credit_pct": { "value": 490, "string": "4,90 %" },
"grand_total": { "value": 51400, "string": "514,00 €" },
"version": "v9_min_amounts_390",
"max_financed_amount": { "value": 300000, "string": "3000,00 €" },
"min_amount": { "value": 5000, "string": "50,00 €" },
"available": true,
"first_instalment_date": { "value": "2022-01-08", "string": "8 de enero" },
"first_instalment_date_overriden": false,
"instalment_count": 3,
"instalment_amount": { "value": 16333, "string": "163,33 €" },
"instalment_fee": { "value": 800, "string": "8,00 €" },
"instalment_total": { "value": 17133, "string": "171,33 €" },
"default": false,
"over_max_financed_amount": { "value": 0, "string": "0,00 €" },
"with_preset_down_payment": false,
"remaining_instalment_count": 2,
"setup_fee": { "value": 0, "string": "0,00 €" },
"down_payment_amount": { "value": 16333, "string": "163,33 €" },
"down_payment_fees": { "value": 800, "string": "8,00 €" },
"down_payment_total": { "value": 17133, "string": "171,33 €" },
"drawdown_payment_amount": { "value": 32667, "string": "326,67 €" },
"with_higher_down_payment": false,
"down_payment_pct": 3333,
"conditions_documents_urls": [
{
"name": "condiciones de contratación",
"url": "...",
"document": "general"
},
{
"name": "la política de privacidad",
"url": "...",
"document": "privacy"
},
{
"name": "oferta de crédito",
"url": "...",
"document": "secci"
}
]
},
{
"product": "pp3",
"apr": { "value": 5838, "string": "58,38 %" },
"interest": { "value": 0, "string": "0,00 %" },
"total_with_tax": { "value": 49000, "string": "490,00 €" },
"cost_of_credit": { "value": 4800, "string": "48,00 €" },
"cost_of_credit_pct": { "value": 980, "string": "9,80 %" },
"grand_total": { "value": 53800, "string": "538,00 €" },
"max_financed_amount": { "value": 300000, "string": "3000,00 €" },
"max_amount": { "value": 300000, "string": "3000,00 €" },
"min_amount": { "value": 5000, "string": "50,00 €" },
"available": true,
"first_instalment_date": { "value": "2022-01-08", "string": "8 de enero" },
"first_instalment_date_overriden": false,
"instalment_count": 6,
"instalment_amount": { "value": 8166, "string": "81,66 €" },
"instalment_fee": { "value": 800, "string": "8,00 €" },
"instalment_total": { "value": 8966, "string": "89,66 €" },
"default": false,
"over_max_financed_amount": { "value": 0, "string": "0,00 €" },
"with_preset_down_payment": false,
"remaining_instalment_count": 5,
"setup_fee": { "value": 0, "string": "0,00 €" },
"down_payment_amount": { "value": 8166, "string": "81,66 €" },
"down_payment_fees": { "value": 800, "string": "8,00 €" },
"down_payment_total": { "value": 8966, "string": "89,66 €" },
"drawdown_payment_amount": { "value": 40834, "string": "408,34 €" },
"with_higher_down_payment": false,
"down_payment_pct": 1667,
"conditions_documents_urls": [
{
"name": "condiciones de contratación",
"url": "...",
"document": "general"
},
{
"name": "la política de privacidad",
"url": "...",
"document": "privacy"
},
{
"name": "oferta de crédito",
"url": "...",
"document": "secci"
}
]
}
]
}Field | Description |
|---|---|
| Token used for the api authorization. |
| seQura product code. |
| Info from the customer to be displayed in the form, prefilled with the data coming from the order creation.
Possible attributes are: |
| Mandatory customer data fields list. Possible attributes are: |
| Total amount of the order, with tax. |
| List of checkboxes to be displayed. |
| Product characteristics (only for part payment products). |
Details of the checkboxes field:
| Field | Description |
|---|---|
id | Checkbox ID. Possible values: sequra_privacy_policy_accepted, sequra_service_duration_accepted |
checked | true if the checkbox should be checked by default |
required | true if the checkbox must be checked to continue. |
url | Location of the related legal document to be read. |
Details of the credit_agreement field (only describing not self explanatory fields)
| Field | Description |
|---|---|
apr | Annual Percentage Rate |
max_financied_amount | seQura will finance up to that amount |
min_amount | Orders below this amount are not possible |
max_amount | Orders above this amount are not possible |
available | The option cannot be offered |
default | Default selection |
over_max_financed_amount | Amount not financed because is over the max_financed_amount and will be paid in the downpayment |
down_payment_pct | Percentage of the downpayment over the grand total |
conditions_documents_urls | List of legal condition documents, containing name, url and document (type) as attributes. |