# checkout session {% columns fullWidth="true" %} {% column %} Checkout sessions represent a temporary, tokenized context in which a payer completes a payment flow. A session is created from a payment link or directly via the API, and it holds the state needed to process a payment — including the selected origins, destinations, and method. Sessions have a limited lifespan and can be refreshed using their associated token. Use the Checkout Sessions API to create sessions, retrieve them, initiate payments within a session, or delete sessions that are no longer needed. {% endcolumn %} {% column %} {% code title="Endpoints" overflow="wrap" %} ```http GET /checkout-sessions GET /checkout-sessions/:checkout_session_id DELETE /checkout-sessions/:checkout_session_id POST /checkout-sessions POST /checkout-sessions/:checkout_session_id/payments POST /checkout-sessions/token/:checkout-token/refresh POST /payment-links/token/:checkout-token/checkout-sessions ``` {% endcode %} {% endcolumn %} {% endcolumns %} ## Get Checkout sessions > Lists checkout sessions with filtering and pagination options. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Checkout-sessions"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}},"schemas":{"pagination-cursor":{"description":"Cursor-based pagination metadata (`limit`, `cursor`, `hasMore`).","type":"object","properties":{"count":{"type":"integer","description":"count of items shown up to the moment"},"next":{"type":"integer","description":"next cursor to be used in offset to display the next page"},"previous":{"type":"integer","description":"previous cursor to be used in offset to display the previous page"},"total":{"type":"integer","description":"total count of items to be shown"}},"required":["next","previous","total","count"]},"_id":{"type":"string","description":"Unique identifier for the internal service."},"currency-config":{"description":"Currency-level checkout configuration for available payment methods.","type":"object","properties":{"currency":{"type":"string","description":"Currency code enabled for the checkout session"},"product":{"type":"string","description":"Product conversion of the checkout session"},"exchangeRate":{"type":"string","description":"Product's exchange rate"},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/payment-method-config"},"description":"Payment methods config list"}},"required":["currency","product","exchangeRate","paymentMethods"]},"payment-method-config":{"description":"Payment-method configuration and limits for a checkout session.","type":"object","properties":{"id":{"type":"string","description":"ID specific type of Payment method"},"type":{"type":"string","description":"Generic type of Payment method"},"enabled":{"type":"boolean","description":"Enabled boolean"},"requiredFields":{"type":"array","items":{"type":"string"},"description":"List of required fields for the provider"},"purchaseAmount":{"type":"string","description":"Calculated amount to pay for the Payment Method"}},"required":["id","type","enabled","requiredFields","purchaseAmount"]},"checkout-session-status":{"type":"string","description":"checkout session status","enum":["ATTEMPT","ACTIVE","EXPIRED","FINISHED","PROCESSING_PAYMENT","FAILED"]},"fee-type":{"type":"string","description":"Type of fee","enum":["FIXED","PERCENTAGE"]},"currency":{"type":"string","description":"Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., `CLP`, `ARS`, `MXN`). Go to the [currencies page](../home/currencies \"mention\") for the complete list of supported values."},"payment-node-type":{"type":"string","description":"Defines the source or destination type of the payment. This field determines how the funds will be sent or received and which structure is expected in the corresponding `node` object. Only one type is allowed per node.\n\n| Type | Node | Country | Direction |\n|---------------|---------------|----------------|------------------|\n| `CARD` | `card` | Multi | Pay-in |\n| `CRYPTO` | `wallet` | Multi | Pay-in / Pay-out |\n| `ACCOUNT` | `account` | Multi | Pay-in / Pay-out |\n| `BANK_ACCOUNT`| `bank` | Multi | Pay-out |\n| `PIX` | `pix` | Brazil | Pay-in / Pay-out |\n| `PCT` | `pct` | Argentina | Pay-in |\n| `CVU` | `cvu` | Argentina | Pay-in |\n| `ETPAY` | `etpay` | Chile | Pay-in |\n| `FINTOC` | `fintoc` | Chile | Pay-in |\n| `WEBPAY` | `webpay` | Chile | Pay-in |\n| `SPEI` | `spei` | Mexico | Pay-in / Pay-out |\n| `PSE` | `pse` | Colombia | Pay-in |\n| `BANCOLOMBIA` | `bancolombia` | Colombia | Pay-in |\n| `DAVIVIENDA` | `davivienda` | Colombia | Pay-in |\n| `DAVIPLATA` | `daviplata` | Colombia | Pay-in / Pay-out |\n| `NEQUI` | `nequi` | Colombia | Pay-in / Pay-out |\n| `BREB` | `breb` | Colombia | Pay-out |\n| `WOMPI` | `wompi` | Colombia | Pay-in |\n| `LIGO` | `ligo` | Peru | Pay-in |\n| `SIP` | `sip` | Peru, Bolivia | Pay-in |\n| `ACH` | `ach` | USA | Pay-in / Pay-out |\n| `WIRE` | `wire` | USA | Pay-out |\n| `FEDNOW` | `fedNow` | USA | Pay-in / Pay-out |\n| `RTP` | `rtp` | USA | Pay-in |\n| `SEPA` | `sepa` | Europe | Pay-out |\n| `FPE` | `fpe` | UK | Pay-out |\n| `SWIFT` | `swift` | Global | Pay-out |","enum":["CARD","CRYPTO","ACCOUNT","BANK_ACCOUNT","PIX","PCT","CVU","ETPAY","FINTOC","WEBPAY","SPEI","PSE","BANCOLOMBIA","DAVIVIENDA","DAVIPLATA","NEQUI","BREB","WOMPI","LIGO","SIP","ACH","WIRE","FEDNOW","RTP","SEPA","FPE","SWIFT"]},"document-type":{"type":"string","description":"Documeny type of the entity (e.g., `RUT`, `CURP`, `CURL`). Go to the [Supported Identity document types page](../home/supported-identity-document-types \"mention\") for the complete list of supported values."},"address":{"type":"object","properties":{"administrativeAreaLevel1":{"type":"string","description":"The first-level administrative division."},"administrativeAreaLevel2":{"type":"string","description":"The second-level administrative division."},"administrativeAreaLevel3":{"type":"string","description":"The third-level administrative division."},"street":{"type":"string","description":"The name of the street."},"streetNumber":{"type":"string","description":"The street number."},"optionalAddress":{"type":"string","description":"Additional address details."},"country":{"$ref":"#/components/schemas/country"},"zipcode":{"type":"string","description":"Zipcode f the address"}},"description":"The entity’s address information."},"country":{"type":"string","description":"Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., `CHL`, `USA`, `MEX`). Go to the [countries page](../home/countries \"mention\") for the complete list of supported values."},"payment-link-destination":{"description":"Destination configuration schema used by payment links.","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the source or destination of the transaction."},"type":{"$ref":"#/components/schemas/payment-node-type"},"externalId":{"type":"string","description":"External reference identifier for integrations."},"amount":{"type":"string","description":"The amount involved in the transaction."},"metadata":{"type":"object","description":"Additional metadata related to the transaction source or destination.","properties":{"image":{"type":"string","description":"An image representing the source or destination."},"description":{"type":"string","description":"A brief description of the source or destination."},"category":{"type":"string","description":"The category or grouping of the source or destination."}},"required":["image","description","category"]}},"required":["type","amount"]},{"$ref":"#/components/schemas/account-wrapper"},{"properties":{"type":{"type":"string","enum":["ACCOUNT"]}},"required":["type"],"type":"object"}]},"account-wrapper":{"description":"Wrapper object exposing the internal `account` node payload.","type":"object","properties":{"account":{"type":"object","properties":{"type":{"description":"The type of internal account.","$ref":"#/components/schemas/account-type"},"currency":{"description":"The currency in which the internal account operates. Please check \"currencies\" page.","$ref":"#/components/schemas/currency"},"accountNumber":{"type":"string","description":"Internal reference number for the account."},"accountHolder":{"type":"string","description":"Name of the entity or user owning the internal account."}},"required":["type","currency","accountNumber","accountHolder"]}},"title":"ACCOUNT","required":["account"]},"account-type":{"type":"string","description":"The type of internal account.","enum":["CHECKING","ASSET","SAVINGS","ESCROW","FEE"]},"node-identity":{"description":"Identity reference object used inside account nodes.","type":"object","properties":{"identityId":{"type":"string","description":"User unique identifier"},"name":{"type":"string","description":"User name"},"lastname":{"type":"string","description":"User lastname"},"nickname":{"type":"string","description":"User nickname"},"documentNumber":{"type":"string","description":"User DNI"},"entityType":{"type":"string","description":"Entity type of identity"}},"additionalProperties":false,"required":["identityId"]},"error":{"type":"object","description":"Standard error response payload.","properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"error":{"type":"string","description":"Error category."},"message":{"type":"string","description":"Human-readable error message."}},"required":["statusCode","error","message"]}},"responses":{"Bad request":{"description":"The request is invalid, malformed, or contains unsupported values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Internal server error":{"description":"The server failed to process the request due to an unexpected condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/checkout-sessions":{"get":{"summary":"Get Checkout sessions","deprecated":false,"description":"Lists checkout sessions with filtering and pagination options.","operationId":"get-checkout-sessions","tags":["Checkout-sessions"],"parameters":[{"name":"identityId","in":"query","description":"Owner Identity Id","required":false,"schema":{"type":"string"}},{"name":"accountNumber","in":"query","description":"Destination Account Number","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Checkout session status","required":false,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"(dd/mm/yyyy) Start date filters created Date min ","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"(dd/mm/yyyy) End date filters created Date max","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Sorts the results by param:asc | param:desc","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Specifies the maximum number of items to return in a single request.","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Skips the input value from the current view","required":false,"schema":{"type":"string"}},{"name":"conomyhq-api-version","in":"header","description":"v1: empty ; v2: 24-04-2025","required":false,"schema":{"type":"string","default":"none, is the first API version"}},{"name":"x-api-key","in":"header","description":"The API key used for authentication when making requests to the API Gateway.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Identifies the application making the request.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request processed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/pagination-cursor","description":"Pagination cursor object"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"paymentLinkId":{"type":"string","description":"Reference Payment Link ID"},"checkoutToken":{"type":"string","description":"Reference for checkout url"},"paymentConfigs":{"type":"array","items":{"$ref":"#/components/schemas/currency-config"}},"createdAt":{"type":"string","description":"When the link expires ","format":"date-time"},"status":{"description":"Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated","$ref":"#/components/schemas/checkout-session-status"},"items":{"type":"array","items":{"type":"object","properties":{"preTaxAmount":{"type":"string","description":"The amount of the item"},"totalAmount":{"type":"string","description":"amount + tax.amount, if no tax it's equal to amount"},"description":{"type":"string","description":"The description of the item"},"tax":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee."},"type":{"description":"The type of fee applied (e.g., FIXED, PERCENTAGE).","$ref":"#/components/schemas/fee-type"},"value":{"type":"string","description":"The value of the fee."},"amount":{"type":"string","description":"The calculated amount of the fee."}},"required":["name","type","value","amount"],"nullable":true}},"required":["preTaxAmount","totalAmount","description"]},"description":"List of items to pay for"},"currency":{"$ref":"#/components/schemas/currency","description":"Currency for payment"},"preTaxAmount":{"type":"string","description":"Addition of all items preTaxAmounts"},"totalAmount":{"type":"string","description":"Addition of all items totalAmounts"},"url":{"type":"string","description":"Url to open checkout flow"},"paymentMethodsAllowed":{"type":"array","items":{"$ref":"#/components/schemas/payment-node-type"},"description":"Allowed payment methods.","minItems":1},"customer":{"description":"Optional customer to pass into the checkout session","type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"firstName":{"type":"string","description":"Payer's name"},"email":{"type":"string","description":"Payer's email"},"lastName":{"type":"string","description":"Payer's last name"},"phoneNumber":{"type":"string","description":"Payer's phone number without prefix"},"phoneNumberPrefix":{"type":"string","description":"Phone number prefix (e.g., +57)"},"documentType":{"$ref":"#/components/schemas/document-type"},"documentNumber":{"type":"string","description":"The document number associated with the documentType"},"address":{"$ref":"#/components/schemas/address"}},"nullable":true},"redirectUrl":{"type":"string","description":"The URL to which the end user will be redirected after completing the payment. "},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/payment-link-destination"},"description":"A list of destinations for the transaction.","minItems":1},"customerRequirements":{"type":"array","items":{"type":"string","description":"customer fields to require on checkout","enum":["firstName","email","lastName","phoneNumber","phoneNumberPrefix","address","documentNumber","documentType"]}},"expiresAt":{"type":"string","format":"date-time"},"owner":{"$ref":"#/components/schemas/node-identity","description":"owner of who created the session"}},"required":["id","paymentConfigs","createdAt","status","items","currency","preTaxAmount","totalAmount","url","paymentMethodsAllowed","destinations","expiresAt","owner"]},"description":"Items from the current page"}},"required":["results","pagination"]}}},"headers":{}},"400":{"$ref":"#/components/responses/Bad request","description":"Invalid request parameters or payload."},"500":{"$ref":"#/components/responses/Internal server error","description":"Unexpected internal server error."}}}}}} ``` ## Get checkout session > Retrieves a checkout session by ID. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Checkout-sessions"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}},"schemas":{"_id":{"type":"string","description":"Unique identifier for the internal service."},"currency-config":{"description":"Currency-level checkout configuration for available payment methods.","type":"object","properties":{"currency":{"type":"string","description":"Currency code enabled for the checkout session"},"product":{"type":"string","description":"Product conversion of the checkout session"},"exchangeRate":{"type":"string","description":"Product's exchange rate"},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/payment-method-config"},"description":"Payment methods config list"}},"required":["currency","product","exchangeRate","paymentMethods"]},"payment-method-config":{"description":"Payment-method configuration and limits for a checkout session.","type":"object","properties":{"id":{"type":"string","description":"ID specific type of Payment method"},"type":{"type":"string","description":"Generic type of Payment method"},"enabled":{"type":"boolean","description":"Enabled boolean"},"requiredFields":{"type":"array","items":{"type":"string"},"description":"List of required fields for the provider"},"purchaseAmount":{"type":"string","description":"Calculated amount to pay for the Payment Method"}},"required":["id","type","enabled","requiredFields","purchaseAmount"]},"checkout-session-status":{"type":"string","description":"checkout session status","enum":["ATTEMPT","ACTIVE","EXPIRED","FINISHED","PROCESSING_PAYMENT","FAILED"]},"fee-type":{"type":"string","description":"Type of fee","enum":["FIXED","PERCENTAGE"]},"currency":{"type":"string","description":"Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., `CLP`, `ARS`, `MXN`). Go to the [currencies page](../home/currencies \"mention\") for the complete list of supported values."},"payment-node-type":{"type":"string","description":"Defines the source or destination type of the payment. This field determines how the funds will be sent or received and which structure is expected in the corresponding `node` object. Only one type is allowed per node.\n\n| Type | Node | Country | Direction |\n|---------------|---------------|----------------|------------------|\n| `CARD` | `card` | Multi | Pay-in |\n| `CRYPTO` | `wallet` | Multi | Pay-in / Pay-out |\n| `ACCOUNT` | `account` | Multi | Pay-in / Pay-out |\n| `BANK_ACCOUNT`| `bank` | Multi | Pay-out |\n| `PIX` | `pix` | Brazil | Pay-in / Pay-out |\n| `PCT` | `pct` | Argentina | Pay-in |\n| `CVU` | `cvu` | Argentina | Pay-in |\n| `ETPAY` | `etpay` | Chile | Pay-in |\n| `FINTOC` | `fintoc` | Chile | Pay-in |\n| `WEBPAY` | `webpay` | Chile | Pay-in |\n| `SPEI` | `spei` | Mexico | Pay-in / Pay-out |\n| `PSE` | `pse` | Colombia | Pay-in |\n| `BANCOLOMBIA` | `bancolombia` | Colombia | Pay-in |\n| `DAVIVIENDA` | `davivienda` | Colombia | Pay-in |\n| `DAVIPLATA` | `daviplata` | Colombia | Pay-in / Pay-out |\n| `NEQUI` | `nequi` | Colombia | Pay-in / Pay-out |\n| `BREB` | `breb` | Colombia | Pay-out |\n| `WOMPI` | `wompi` | Colombia | Pay-in |\n| `LIGO` | `ligo` | Peru | Pay-in |\n| `SIP` | `sip` | Peru, Bolivia | Pay-in |\n| `ACH` | `ach` | USA | Pay-in / Pay-out |\n| `WIRE` | `wire` | USA | Pay-out |\n| `FEDNOW` | `fedNow` | USA | Pay-in / Pay-out |\n| `RTP` | `rtp` | USA | Pay-in |\n| `SEPA` | `sepa` | Europe | Pay-out |\n| `FPE` | `fpe` | UK | Pay-out |\n| `SWIFT` | `swift` | Global | Pay-out |","enum":["CARD","CRYPTO","ACCOUNT","BANK_ACCOUNT","PIX","PCT","CVU","ETPAY","FINTOC","WEBPAY","SPEI","PSE","BANCOLOMBIA","DAVIVIENDA","DAVIPLATA","NEQUI","BREB","WOMPI","LIGO","SIP","ACH","WIRE","FEDNOW","RTP","SEPA","FPE","SWIFT"]},"document-type":{"type":"string","description":"Documeny type of the entity (e.g., `RUT`, `CURP`, `CURL`). Go to the [Supported Identity document types page](../home/supported-identity-document-types \"mention\") for the complete list of supported values."},"address":{"type":"object","properties":{"administrativeAreaLevel1":{"type":"string","description":"The first-level administrative division."},"administrativeAreaLevel2":{"type":"string","description":"The second-level administrative division."},"administrativeAreaLevel3":{"type":"string","description":"The third-level administrative division."},"street":{"type":"string","description":"The name of the street."},"streetNumber":{"type":"string","description":"The street number."},"optionalAddress":{"type":"string","description":"Additional address details."},"country":{"$ref":"#/components/schemas/country"},"zipcode":{"type":"string","description":"Zipcode f the address"}},"description":"The entity’s address information."},"country":{"type":"string","description":"Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., `CHL`, `USA`, `MEX`). Go to the [countries page](../home/countries \"mention\") for the complete list of supported values."},"payment-link-destination":{"description":"Destination configuration schema used by payment links.","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the source or destination of the transaction."},"type":{"$ref":"#/components/schemas/payment-node-type"},"externalId":{"type":"string","description":"External reference identifier for integrations."},"amount":{"type":"string","description":"The amount involved in the transaction."},"metadata":{"type":"object","description":"Additional metadata related to the transaction source or destination.","properties":{"image":{"type":"string","description":"An image representing the source or destination."},"description":{"type":"string","description":"A brief description of the source or destination."},"category":{"type":"string","description":"The category or grouping of the source or destination."}},"required":["image","description","category"]}},"required":["type","amount"]},{"$ref":"#/components/schemas/account-wrapper"},{"properties":{"type":{"type":"string","enum":["ACCOUNT"]}},"required":["type"],"type":"object"}]},"account-wrapper":{"description":"Wrapper object exposing the internal `account` node payload.","type":"object","properties":{"account":{"type":"object","properties":{"type":{"description":"The type of internal account.","$ref":"#/components/schemas/account-type"},"currency":{"description":"The currency in which the internal account operates. Please check \"currencies\" page.","$ref":"#/components/schemas/currency"},"accountNumber":{"type":"string","description":"Internal reference number for the account."},"accountHolder":{"type":"string","description":"Name of the entity or user owning the internal account."}},"required":["type","currency","accountNumber","accountHolder"]}},"title":"ACCOUNT","required":["account"]},"account-type":{"type":"string","description":"The type of internal account.","enum":["CHECKING","ASSET","SAVINGS","ESCROW","FEE"]},"node-identity":{"description":"Identity reference object used inside account nodes.","type":"object","properties":{"identityId":{"type":"string","description":"User unique identifier"},"name":{"type":"string","description":"User name"},"lastname":{"type":"string","description":"User lastname"},"nickname":{"type":"string","description":"User nickname"},"documentNumber":{"type":"string","description":"User DNI"},"entityType":{"type":"string","description":"Entity type of identity"}},"additionalProperties":false,"required":["identityId"]},"error":{"type":"object","description":"Standard error response payload.","properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"error":{"type":"string","description":"Error category."},"message":{"type":"string","description":"Human-readable error message."}},"required":["statusCode","error","message"]}},"responses":{"Bad request":{"description":"The request is invalid, malformed, or contains unsupported values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Internal server error":{"description":"The server failed to process the request due to an unexpected condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/checkout-sessions/{checkout_session_id}":{"get":{"summary":"Get checkout session","deprecated":false,"description":"Retrieves a checkout session by ID.","operationId":"get-checkout-session","tags":["Checkout-sessions"],"parameters":[{"name":"checkout_session_id","in":"path","description":"Unique identifier of the checkout session.","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","description":"The API key used for authentication when making requests to the API Gateway.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Identifies the application making the request.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request processed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"paymentLinkId":{"type":"string","description":"Reference Payment Link ID"},"checkoutToken":{"type":"string","description":"Reference for checkout url"},"paymentConfigs":{"type":"array","items":{"$ref":"#/components/schemas/currency-config"}},"createdAt":{"type":"string","description":"When the link expires ","format":"date-time"},"status":{"description":"Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated","$ref":"#/components/schemas/checkout-session-status"},"items":{"type":"array","items":{"type":"object","properties":{"preTaxAmount":{"type":"string","description":"The amount of the item"},"totalAmount":{"type":"string","description":"amount + tax.amount, if no tax it's equal to amount"},"description":{"type":"string","description":"The description of the item"},"tax":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee."},"type":{"description":"The type of fee applied (e.g., FIXED, PERCENTAGE).","$ref":"#/components/schemas/fee-type"},"value":{"type":"string","description":"The value of the fee."},"amount":{"type":"string","description":"The calculated amount of the fee."}},"required":["name","type","value","amount"],"nullable":true}},"required":["preTaxAmount","totalAmount","description"]},"description":"List of items to pay for"},"currency":{"$ref":"#/components/schemas/currency","description":"Currency for payment"},"preTaxAmount":{"type":"string","description":"Addition of all items preTaxAmounts"},"totalAmount":{"type":"string","description":"Addition of all items totalAmounts"},"url":{"type":"string","description":"Url to open checkout flow"},"paymentMethodsAllowed":{"type":"array","items":{"$ref":"#/components/schemas/payment-node-type"},"description":"Allowed payment methods.","minItems":1},"customer":{"description":"Optional customer to pass into the checkout session","type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"firstName":{"type":"string","description":"Payer's name"},"email":{"type":"string","description":"Payer's email"},"lastName":{"type":"string","description":"Payer's last name"},"phoneNumber":{"type":"string","description":"Payer's phone number without prefix"},"phoneNumberPrefix":{"type":"string","description":"Phone number prefix (e.g., +57)"},"documentType":{"$ref":"#/components/schemas/document-type"},"documentNumber":{"type":"string","description":"The document number associated with the documentType"},"address":{"$ref":"#/components/schemas/address"}},"nullable":true},"redirectUrl":{"type":"string","description":"The URL to which the end user will be redirected after completing the payment. "},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/payment-link-destination"},"description":"A list of destinations for the transaction.","minItems":1},"customerRequirements":{"type":"array","items":{"type":"string","description":"customer fields to require on checkout","enum":["firstName","email","lastName","phoneNumber","phoneNumberPrefix","address","documentNumber","documentType"]}},"expiresAt":{"type":"string","format":"date-time"},"owner":{"$ref":"#/components/schemas/node-identity","description":"owner of who created the session"}},"required":["id","paymentConfigs","createdAt","status","items","currency","preTaxAmount","totalAmount","url","paymentMethodsAllowed","destinations","expiresAt","owner"]}}},"headers":{}},"400":{"$ref":"#/components/responses/Bad request","description":"Invalid request parameters or payload."},"500":{"$ref":"#/components/responses/Internal server error","description":"Unexpected internal server error."}}}}}} ``` ## Delete checkout session > Deletes (invalidates) a checkout session. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Checkout-sessions"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}},"responses":{"Bad request":{"description":"The request is invalid, malformed, or contains unsupported values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Internal server error":{"description":"The server failed to process the request due to an unexpected condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"error":{"type":"object","description":"Standard error response payload.","properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"error":{"type":"string","description":"Error category."},"message":{"type":"string","description":"Human-readable error message."}},"required":["statusCode","error","message"]}}},"paths":{"/checkout-sessions/{checkout_session_id}":{"delete":{"summary":"Delete checkout session","deprecated":false,"description":"Deletes (invalidates) a checkout session.","operationId":"delete-checkout-session","tags":["Checkout-sessions"],"parameters":[{"name":"checkout_session_id","in":"path","description":"Unique identifier of the checkout session to delete.","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","description":"The API key used for authentication when making requests to the API Gateway.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Identifies the application making the request.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Request processed successfully.","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}},"400":{"$ref":"#/components/responses/Bad request","description":"Invalid request parameters or payload."},"500":{"$ref":"#/components/responses/Internal server error","description":"Unexpected internal server error."}}}}}} ``` ## Refresh checkout session > Refreshes a checkout session token and returns updated session data. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Checkout-sessions"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}},"schemas":{"_id":{"type":"string","description":"Unique identifier for the internal service."},"currency-config":{"description":"Currency-level checkout configuration for available payment methods.","type":"object","properties":{"currency":{"type":"string","description":"Currency code enabled for the checkout session"},"product":{"type":"string","description":"Product conversion of the checkout session"},"exchangeRate":{"type":"string","description":"Product's exchange rate"},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/payment-method-config"},"description":"Payment methods config list"}},"required":["currency","product","exchangeRate","paymentMethods"]},"payment-method-config":{"description":"Payment-method configuration and limits for a checkout session.","type":"object","properties":{"id":{"type":"string","description":"ID specific type of Payment method"},"type":{"type":"string","description":"Generic type of Payment method"},"enabled":{"type":"boolean","description":"Enabled boolean"},"requiredFields":{"type":"array","items":{"type":"string"},"description":"List of required fields for the provider"},"purchaseAmount":{"type":"string","description":"Calculated amount to pay for the Payment Method"}},"required":["id","type","enabled","requiredFields","purchaseAmount"]},"checkout-session-status":{"type":"string","description":"checkout session status","enum":["ATTEMPT","ACTIVE","EXPIRED","FINISHED","PROCESSING_PAYMENT","FAILED"]},"fee-type":{"type":"string","description":"Type of fee","enum":["FIXED","PERCENTAGE"]},"currency":{"type":"string","description":"Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., `CLP`, `ARS`, `MXN`). Go to the [currencies page](../home/currencies \"mention\") for the complete list of supported values."},"payment-node-type":{"type":"string","description":"Defines the source or destination type of the payment. This field determines how the funds will be sent or received and which structure is expected in the corresponding `node` object. Only one type is allowed per node.\n\n| Type | Node | Country | Direction |\n|---------------|---------------|----------------|------------------|\n| `CARD` | `card` | Multi | Pay-in |\n| `CRYPTO` | `wallet` | Multi | Pay-in / Pay-out |\n| `ACCOUNT` | `account` | Multi | Pay-in / Pay-out |\n| `BANK_ACCOUNT`| `bank` | Multi | Pay-out |\n| `PIX` | `pix` | Brazil | Pay-in / Pay-out |\n| `PCT` | `pct` | Argentina | Pay-in |\n| `CVU` | `cvu` | Argentina | Pay-in |\n| `ETPAY` | `etpay` | Chile | Pay-in |\n| `FINTOC` | `fintoc` | Chile | Pay-in |\n| `WEBPAY` | `webpay` | Chile | Pay-in |\n| `SPEI` | `spei` | Mexico | Pay-in / Pay-out |\n| `PSE` | `pse` | Colombia | Pay-in |\n| `BANCOLOMBIA` | `bancolombia` | Colombia | Pay-in |\n| `DAVIVIENDA` | `davivienda` | Colombia | Pay-in |\n| `DAVIPLATA` | `daviplata` | Colombia | Pay-in / Pay-out |\n| `NEQUI` | `nequi` | Colombia | Pay-in / Pay-out |\n| `BREB` | `breb` | Colombia | Pay-out |\n| `WOMPI` | `wompi` | Colombia | Pay-in |\n| `LIGO` | `ligo` | Peru | Pay-in |\n| `SIP` | `sip` | Peru, Bolivia | Pay-in |\n| `ACH` | `ach` | USA | Pay-in / Pay-out |\n| `WIRE` | `wire` | USA | Pay-out |\n| `FEDNOW` | `fedNow` | USA | Pay-in / Pay-out |\n| `RTP` | `rtp` | USA | Pay-in |\n| `SEPA` | `sepa` | Europe | Pay-out |\n| `FPE` | `fpe` | UK | Pay-out |\n| `SWIFT` | `swift` | Global | Pay-out |","enum":["CARD","CRYPTO","ACCOUNT","BANK_ACCOUNT","PIX","PCT","CVU","ETPAY","FINTOC","WEBPAY","SPEI","PSE","BANCOLOMBIA","DAVIVIENDA","DAVIPLATA","NEQUI","BREB","WOMPI","LIGO","SIP","ACH","WIRE","FEDNOW","RTP","SEPA","FPE","SWIFT"]},"document-type":{"type":"string","description":"Documeny type of the entity (e.g., `RUT`, `CURP`, `CURL`). Go to the [Supported Identity document types page](../home/supported-identity-document-types \"mention\") for the complete list of supported values."},"address":{"type":"object","properties":{"administrativeAreaLevel1":{"type":"string","description":"The first-level administrative division."},"administrativeAreaLevel2":{"type":"string","description":"The second-level administrative division."},"administrativeAreaLevel3":{"type":"string","description":"The third-level administrative division."},"street":{"type":"string","description":"The name of the street."},"streetNumber":{"type":"string","description":"The street number."},"optionalAddress":{"type":"string","description":"Additional address details."},"country":{"$ref":"#/components/schemas/country"},"zipcode":{"type":"string","description":"Zipcode f the address"}},"description":"The entity’s address information."},"country":{"type":"string","description":"Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., `CHL`, `USA`, `MEX`). Go to the [countries page](../home/countries \"mention\") for the complete list of supported values."},"payment-link-destination":{"description":"Destination configuration schema used by payment links.","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the source or destination of the transaction."},"type":{"$ref":"#/components/schemas/payment-node-type"},"externalId":{"type":"string","description":"External reference identifier for integrations."},"amount":{"type":"string","description":"The amount involved in the transaction."},"metadata":{"type":"object","description":"Additional metadata related to the transaction source or destination.","properties":{"image":{"type":"string","description":"An image representing the source or destination."},"description":{"type":"string","description":"A brief description of the source or destination."},"category":{"type":"string","description":"The category or grouping of the source or destination."}},"required":["image","description","category"]}},"required":["type","amount"]},{"$ref":"#/components/schemas/account-wrapper"},{"properties":{"type":{"type":"string","enum":["ACCOUNT"]}},"required":["type"],"type":"object"}]},"account-wrapper":{"description":"Wrapper object exposing the internal `account` node payload.","type":"object","properties":{"account":{"type":"object","properties":{"type":{"description":"The type of internal account.","$ref":"#/components/schemas/account-type"},"currency":{"description":"The currency in which the internal account operates. Please check \"currencies\" page.","$ref":"#/components/schemas/currency"},"accountNumber":{"type":"string","description":"Internal reference number for the account."},"accountHolder":{"type":"string","description":"Name of the entity or user owning the internal account."}},"required":["type","currency","accountNumber","accountHolder"]}},"title":"ACCOUNT","required":["account"]},"account-type":{"type":"string","description":"The type of internal account.","enum":["CHECKING","ASSET","SAVINGS","ESCROW","FEE"]},"node-identity":{"description":"Identity reference object used inside account nodes.","type":"object","properties":{"identityId":{"type":"string","description":"User unique identifier"},"name":{"type":"string","description":"User name"},"lastname":{"type":"string","description":"User lastname"},"nickname":{"type":"string","description":"User nickname"},"documentNumber":{"type":"string","description":"User DNI"},"entityType":{"type":"string","description":"Entity type of identity"}},"additionalProperties":false,"required":["identityId"]},"error":{"type":"object","description":"Standard error response payload.","properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"error":{"type":"string","description":"Error category."},"message":{"type":"string","description":"Human-readable error message."}},"required":["statusCode","error","message"]}},"responses":{"Bad request":{"description":"The request is invalid, malformed, or contains unsupported values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Internal server error":{"description":"The server failed to process the request due to an unexpected condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/checkout-sessions/token/{checkout-token}/refresh":{"post":{"summary":"Refresh checkout session","deprecated":false,"description":"Refreshes a checkout session token and returns updated session data.","operationId":"create-checkout-session","tags":["Checkout-sessions"],"parameters":[{"name":"checkout-token","in":"path","description":"Checkout token of the session to refresh.","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","description":"The API key used for authentication when making requests to the API Gateway.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Identifies the application making the request.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"201":{"description":"Resource created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"paymentLinkId":{"type":"string","description":"Reference Payment Link ID"},"checkoutToken":{"type":"string","description":"Reference for checkout url"},"paymentConfigs":{"type":"array","items":{"$ref":"#/components/schemas/currency-config"}},"createdAt":{"type":"string","description":"When the link expires ","format":"date-time"},"status":{"description":"Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated","$ref":"#/components/schemas/checkout-session-status"},"items":{"type":"array","items":{"type":"object","properties":{"preTaxAmount":{"type":"string","description":"The amount of the item"},"totalAmount":{"type":"string","description":"amount + tax.amount, if no tax it's equal to amount"},"description":{"type":"string","description":"The description of the item"},"tax":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee."},"type":{"description":"The type of fee applied (e.g., FIXED, PERCENTAGE).","$ref":"#/components/schemas/fee-type"},"value":{"type":"string","description":"The value of the fee."},"amount":{"type":"string","description":"The calculated amount of the fee."}},"required":["name","type","value","amount"],"nullable":true}},"required":["preTaxAmount","totalAmount","description"]},"description":"List of items to pay for"},"currency":{"$ref":"#/components/schemas/currency","description":"Currency for payment"},"preTaxAmount":{"type":"string","description":"Addition of all items preTaxAmounts"},"totalAmount":{"type":"string","description":"Addition of all items totalAmounts"},"url":{"type":"string","description":"Url to open checkout flow"},"paymentMethodsAllowed":{"type":"array","items":{"$ref":"#/components/schemas/payment-node-type"},"description":"Allowed payment methods.","minItems":1},"customer":{"description":"Optional customer to pass into the checkout session","type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"firstName":{"type":"string","description":"Payer's name"},"email":{"type":"string","description":"Payer's email"},"lastName":{"type":"string","description":"Payer's last name"},"phoneNumber":{"type":"string","description":"Payer's phone number without prefix"},"phoneNumberPrefix":{"type":"string","description":"Phone number prefix (e.g., +57)"},"documentType":{"$ref":"#/components/schemas/document-type"},"documentNumber":{"type":"string","description":"The document number associated with the documentType"},"address":{"$ref":"#/components/schemas/address"}},"nullable":true},"redirectUrl":{"type":"string","description":"The URL to which the end user will be redirected after completing the payment. "},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/payment-link-destination"},"description":"A list of destinations for the transaction.","minItems":1},"customerRequirements":{"type":"array","items":{"type":"string","description":"customer fields to require on checkout","enum":["firstName","email","lastName","phoneNumber","phoneNumberPrefix","address","documentNumber","documentType"]}},"expiresAt":{"type":"string","format":"date-time"},"owner":{"$ref":"#/components/schemas/node-identity","description":"owner of who created the session"}},"required":["id","paymentConfigs","createdAt","status","items","currency","preTaxAmount","totalAmount","url","paymentMethodsAllowed","destinations","expiresAt","owner"]}}},"headers":{}},"400":{"$ref":"#/components/responses/Bad request","description":"Invalid request parameters or payload."},"500":{"$ref":"#/components/responses/Internal server error","description":"Unexpected internal server error."}}}}}} ``` ## Create checkout session > Creates a checkout session for a payment link. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Checkout-sessions"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}},"schemas":{"create-checkout-session":{"description":"Request payload used to create a checkout session.","type":"object","properties":{"checkoutToken":{"type":"string","description":"Reference for checkout url"},"items":{"type":"array","items":{"type":"object","properties":{"preTaxAmount":{"type":"string","description":"The amount of the item"},"totalAmount":{"type":"string","description":"amount + tax.amount, if no tax it's equal to amount"},"description":{"type":"string","description":"The description of the item"},"tax":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee."},"type":{"description":"The type of fee applied (e.g., FIXED, PERCENTAGE).","$ref":"#/components/schemas/fee-type"},"value":{"type":"string","description":"The value of the fee."},"amount":{"type":"string","description":"The calculated amount of the fee."}},"required":["name","type","value","amount"],"nullable":true}},"required":["preTaxAmount","totalAmount","description"]},"description":"List of items to pay for"},"currency":{"$ref":"#/components/schemas/currency","description":"Currency for payment"},"paymentMethodsAllowed":{"type":"array","items":{"$ref":"#/components/schemas/payment-node-type"},"description":"Allowed payment methods.","minItems":1},"customer":{"description":"Optional customer to pass into the checkout session","type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"firstName":{"type":"string","description":"Payer's name"},"email":{"type":"string","description":"Payer's email"},"lastName":{"type":"string","description":"Payer's last name"},"phoneNumber":{"type":"string","description":"Payer's phone number without prefix"},"phoneNumberPrefix":{"type":"string","description":"Phone number prefix (e.g., +57)"},"documentType":{"$ref":"#/components/schemas/document-type"},"documentNumber":{"type":"string","description":"The document number associated with the documentType"},"address":{"$ref":"#/components/schemas/address"}},"nullable":true},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/payment-link-destination"},"description":"A list of destinations for the transaction.","minItems":1},"duration":{"type":"integer","description":"Amount of seconds for payment link to be inactivated after creation","minimum":30},"customerRequirements":{"type":"array","items":{"type":"string","description":"customer fields to require on checkout","enum":["firstName","email","lastName","phoneNumber","phoneNumberPrefix","address","documentNumber","documentType"]}},"owner":{"description":"owner of who created the payment link","$ref":"#/components/schemas/node-identity"},"successUrl":{"type":"string","description":"The URL to which the end user will be redirected after successful payment completion."},"failedUrl":{"type":"string","description":"The URL to which the end user will be redirected after failed payment or cancellation."}},"required":["checkoutToken","items","currency","paymentMethodsAllowed","destinations","duration","owner"]},"fee-type":{"type":"string","description":"Type of fee","enum":["FIXED","PERCENTAGE"]},"currency":{"type":"string","description":"Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., `CLP`, `ARS`, `MXN`). Go to the [currencies page](../home/currencies \"mention\") for the complete list of supported values."},"payment-node-type":{"type":"string","description":"Defines the source or destination type of the payment. This field determines how the funds will be sent or received and which structure is expected in the corresponding `node` object. Only one type is allowed per node.\n\n| Type | Node | Country | Direction |\n|---------------|---------------|----------------|------------------|\n| `CARD` | `card` | Multi | Pay-in |\n| `CRYPTO` | `wallet` | Multi | Pay-in / Pay-out |\n| `ACCOUNT` | `account` | Multi | Pay-in / Pay-out |\n| `BANK_ACCOUNT`| `bank` | Multi | Pay-out |\n| `PIX` | `pix` | Brazil | Pay-in / Pay-out |\n| `PCT` | `pct` | Argentina | Pay-in |\n| `CVU` | `cvu` | Argentina | Pay-in |\n| `ETPAY` | `etpay` | Chile | Pay-in |\n| `FINTOC` | `fintoc` | Chile | Pay-in |\n| `WEBPAY` | `webpay` | Chile | Pay-in |\n| `SPEI` | `spei` | Mexico | Pay-in / Pay-out |\n| `PSE` | `pse` | Colombia | Pay-in |\n| `BANCOLOMBIA` | `bancolombia` | Colombia | Pay-in |\n| `DAVIVIENDA` | `davivienda` | Colombia | Pay-in |\n| `DAVIPLATA` | `daviplata` | Colombia | Pay-in / Pay-out |\n| `NEQUI` | `nequi` | Colombia | Pay-in / Pay-out |\n| `BREB` | `breb` | Colombia | Pay-out |\n| `WOMPI` | `wompi` | Colombia | Pay-in |\n| `LIGO` | `ligo` | Peru | Pay-in |\n| `SIP` | `sip` | Peru, Bolivia | Pay-in |\n| `ACH` | `ach` | USA | Pay-in / Pay-out |\n| `WIRE` | `wire` | USA | Pay-out |\n| `FEDNOW` | `fedNow` | USA | Pay-in / Pay-out |\n| `RTP` | `rtp` | USA | Pay-in |\n| `SEPA` | `sepa` | Europe | Pay-out |\n| `FPE` | `fpe` | UK | Pay-out |\n| `SWIFT` | `swift` | Global | Pay-out |","enum":["CARD","CRYPTO","ACCOUNT","BANK_ACCOUNT","PIX","PCT","CVU","ETPAY","FINTOC","WEBPAY","SPEI","PSE","BANCOLOMBIA","DAVIVIENDA","DAVIPLATA","NEQUI","BREB","WOMPI","LIGO","SIP","ACH","WIRE","FEDNOW","RTP","SEPA","FPE","SWIFT"]},"_id":{"type":"string","description":"Unique identifier for the internal service."},"document-type":{"type":"string","description":"Documeny type of the entity (e.g., `RUT`, `CURP`, `CURL`). Go to the [Supported Identity document types page](../home/supported-identity-document-types \"mention\") for the complete list of supported values."},"address":{"type":"object","properties":{"administrativeAreaLevel1":{"type":"string","description":"The first-level administrative division."},"administrativeAreaLevel2":{"type":"string","description":"The second-level administrative division."},"administrativeAreaLevel3":{"type":"string","description":"The third-level administrative division."},"street":{"type":"string","description":"The name of the street."},"streetNumber":{"type":"string","description":"The street number."},"optionalAddress":{"type":"string","description":"Additional address details."},"country":{"$ref":"#/components/schemas/country"},"zipcode":{"type":"string","description":"Zipcode f the address"}},"description":"The entity’s address information."},"country":{"type":"string","description":"Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., `CHL`, `USA`, `MEX`). Go to the [countries page](../home/countries \"mention\") for the complete list of supported values."},"payment-link-destination":{"description":"Destination configuration schema used by payment links.","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the source or destination of the transaction."},"type":{"$ref":"#/components/schemas/payment-node-type"},"externalId":{"type":"string","description":"External reference identifier for integrations."},"amount":{"type":"string","description":"The amount involved in the transaction."},"metadata":{"type":"object","description":"Additional metadata related to the transaction source or destination.","properties":{"image":{"type":"string","description":"An image representing the source or destination."},"description":{"type":"string","description":"A brief description of the source or destination."},"category":{"type":"string","description":"The category or grouping of the source or destination."}},"required":["image","description","category"]}},"required":["type","amount"]},{"$ref":"#/components/schemas/account-wrapper"},{"properties":{"type":{"type":"string","enum":["ACCOUNT"]}},"required":["type"],"type":"object"}]},"account-wrapper":{"description":"Wrapper object exposing the internal `account` node payload.","type":"object","properties":{"account":{"type":"object","properties":{"type":{"description":"The type of internal account.","$ref":"#/components/schemas/account-type"},"currency":{"description":"The currency in which the internal account operates. Please check \"currencies\" page.","$ref":"#/components/schemas/currency"},"accountNumber":{"type":"string","description":"Internal reference number for the account."},"accountHolder":{"type":"string","description":"Name of the entity or user owning the internal account."}},"required":["type","currency","accountNumber","accountHolder"]}},"title":"ACCOUNT","required":["account"]},"account-type":{"type":"string","description":"The type of internal account.","enum":["CHECKING","ASSET","SAVINGS","ESCROW","FEE"]},"node-identity":{"description":"Identity reference object used inside account nodes.","type":"object","properties":{"identityId":{"type":"string","description":"User unique identifier"},"name":{"type":"string","description":"User name"},"lastname":{"type":"string","description":"User lastname"},"nickname":{"type":"string","description":"User nickname"},"documentNumber":{"type":"string","description":"User DNI"},"entityType":{"type":"string","description":"Entity type of identity"}},"additionalProperties":false,"required":["identityId"]},"currency-config":{"description":"Currency-level checkout configuration for available payment methods.","type":"object","properties":{"currency":{"type":"string","description":"Currency code enabled for the checkout session"},"product":{"type":"string","description":"Product conversion of the checkout session"},"exchangeRate":{"type":"string","description":"Product's exchange rate"},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/payment-method-config"},"description":"Payment methods config list"}},"required":["currency","product","exchangeRate","paymentMethods"]},"payment-method-config":{"description":"Payment-method configuration and limits for a checkout session.","type":"object","properties":{"id":{"type":"string","description":"ID specific type of Payment method"},"type":{"type":"string","description":"Generic type of Payment method"},"enabled":{"type":"boolean","description":"Enabled boolean"},"requiredFields":{"type":"array","items":{"type":"string"},"description":"List of required fields for the provider"},"purchaseAmount":{"type":"string","description":"Calculated amount to pay for the Payment Method"}},"required":["id","type","enabled","requiredFields","purchaseAmount"]},"checkout-session-status":{"type":"string","description":"checkout session status","enum":["ATTEMPT","ACTIVE","EXPIRED","FINISHED","PROCESSING_PAYMENT","FAILED"]},"error":{"type":"object","description":"Standard error response payload.","properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"error":{"type":"string","description":"Error category."},"message":{"type":"string","description":"Human-readable error message."}},"required":["statusCode","error","message"]}},"responses":{"Bad request":{"description":"The request is invalid, malformed, or contains unsupported values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Internal server error":{"description":"The server failed to process the request due to an unexpected condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/checkout-sessions":{"post":{"summary":"Create checkout session","deprecated":false,"description":"Creates a checkout session for a payment link.","operationId":"refresh-checkout-session","tags":["Checkout-sessions"],"parameters":[{"name":"x-api-key","in":"header","description":"The API key used for authentication when making requests to the API Gateway.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Identifies the application making the request.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create-checkout-session"}}}},"responses":{"201":{"description":"Resource created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"paymentLinkId":{"type":"string","description":"Reference Payment Link ID"},"checkoutToken":{"type":"string","description":"Reference for checkout url"},"paymentConfigs":{"type":"array","items":{"$ref":"#/components/schemas/currency-config"}},"createdAt":{"type":"string","description":"When the link expires ","format":"date-time"},"status":{"description":"Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated","$ref":"#/components/schemas/checkout-session-status"},"items":{"type":"array","items":{"type":"object","properties":{"preTaxAmount":{"type":"string","description":"The amount of the item"},"totalAmount":{"type":"string","description":"amount + tax.amount, if no tax it's equal to amount"},"description":{"type":"string","description":"The description of the item"},"tax":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee."},"type":{"description":"The type of fee applied (e.g., FIXED, PERCENTAGE).","$ref":"#/components/schemas/fee-type"},"value":{"type":"string","description":"The value of the fee."},"amount":{"type":"string","description":"The calculated amount of the fee."}},"required":["name","type","value","amount"],"nullable":true}},"required":["preTaxAmount","totalAmount","description"]},"description":"List of items to pay for"},"currency":{"$ref":"#/components/schemas/currency","description":"Currency for payment"},"preTaxAmount":{"type":"string","description":"Addition of all items preTaxAmounts"},"totalAmount":{"type":"string","description":"Addition of all items totalAmounts"},"url":{"type":"string","description":"Url to open checkout flow"},"paymentMethodsAllowed":{"type":"array","items":{"$ref":"#/components/schemas/payment-node-type"},"description":"Allowed payment methods.","minItems":1},"customer":{"description":"Optional customer to pass into the checkout session","type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"firstName":{"type":"string","description":"Payer's name"},"email":{"type":"string","description":"Payer's email"},"lastName":{"type":"string","description":"Payer's last name"},"phoneNumber":{"type":"string","description":"Payer's phone number without prefix"},"phoneNumberPrefix":{"type":"string","description":"Phone number prefix (e.g., +57)"},"documentType":{"$ref":"#/components/schemas/document-type"},"documentNumber":{"type":"string","description":"The document number associated with the documentType"},"address":{"$ref":"#/components/schemas/address"}},"nullable":true},"redirectUrl":{"type":"string","description":"The URL to which the end user will be redirected after completing the payment. "},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/payment-link-destination"},"description":"A list of destinations for the transaction.","minItems":1},"customerRequirements":{"type":"array","items":{"type":"string","description":"customer fields to require on checkout","enum":["firstName","email","lastName","phoneNumber","phoneNumberPrefix","address","documentNumber","documentType"]}},"expiresAt":{"type":"string","format":"date-time"},"owner":{"$ref":"#/components/schemas/node-identity","description":"owner of who created the session"}},"required":["id","paymentConfigs","createdAt","status","items","currency","preTaxAmount","totalAmount","url","paymentMethodsAllowed","destinations","expiresAt","owner"]}}},"headers":{}},"400":{"$ref":"#/components/responses/Bad request","description":"Invalid request parameters or payload."},"500":{"$ref":"#/components/responses/Internal server error","description":"Unexpected internal server error."}}}}}} ``` ## Create Payment from checkout session > When creating a transaction from a checkout session, this endpoint provides a payment method and a provider system to process the payment. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Checkout-sessions"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}},"schemas":{"checkout-session-payment":{"description":"Request payload to submit a payment in an active checkout session.","type":"object","properties":{"description":{"type":"string","description":"A brief description of the transaction."},"origins":{"type":"array","description":"A list of sources for the transaction.","items":{"$ref":"#/components/schemas/payment-node"}}}},"payment-node":{"description":"Payment node schema used in create/update payment requests.","allOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"External reference identifier for integrations."},"name":{"type":"string","description":"The name of the source or destination of the transaction."},"type":{"$ref":"#/components/schemas/payment-node-type"},"amount":{"type":"string","description":"The amount involved in the transaction."},"currency":{"$ref":"#/components/schemas/currency"},"settlement":{"type":"string","description":"Indicates the settlement period."},"fee":{"description":"Details about any fees applied to the transaction.","$ref":"#/components/schemas/fee"},"identity":{"type":"object","description":"The entity associated with the source or destination.","properties":{}},"metadata":{"type":"object","description":"Additional metadata related to the transaction source or destination.","properties":{"image":{"type":"string","description":"An image representing the source or destination."},"description":{"type":"string","description":"A brief description of the source or destination."},"category":{"type":"string","description":"The category or grouping of the source or destination."}},"required":["image","description","category"]},"amountOut":{"type":"string","description":"Calculated amount - fees"}},"required":["type","currency"],"$ref":"#/components/schemas/payment-node-base"},{"$ref":"#/components/schemas/node-wrapper"}],"title":"payment-node"},"payment-node-type":{"type":"string","description":"Defines the source or destination type of the payment. This field determines how the funds will be sent or received and which structure is expected in the corresponding `node` object. Only one type is allowed per node.\n\n| Type | Node | Country | Direction |\n|---------------|---------------|----------------|------------------|\n| `CARD` | `card` | Multi | Pay-in |\n| `CRYPTO` | `wallet` | Multi | Pay-in / Pay-out |\n| `ACCOUNT` | `account` | Multi | Pay-in / Pay-out |\n| `BANK_ACCOUNT`| `bank` | Multi | Pay-out |\n| `PIX` | `pix` | Brazil | Pay-in / Pay-out |\n| `PCT` | `pct` | Argentina | Pay-in |\n| `CVU` | `cvu` | Argentina | Pay-in |\n| `ETPAY` | `etpay` | Chile | Pay-in |\n| `FINTOC` | `fintoc` | Chile | Pay-in |\n| `WEBPAY` | `webpay` | Chile | Pay-in |\n| `SPEI` | `spei` | Mexico | Pay-in / Pay-out |\n| `PSE` | `pse` | Colombia | Pay-in |\n| `BANCOLOMBIA` | `bancolombia` | Colombia | Pay-in |\n| `DAVIVIENDA` | `davivienda` | Colombia | Pay-in |\n| `DAVIPLATA` | `daviplata` | Colombia | Pay-in / Pay-out |\n| `NEQUI` | `nequi` | Colombia | Pay-in / Pay-out |\n| `BREB` | `breb` | Colombia | Pay-out |\n| `WOMPI` | `wompi` | Colombia | Pay-in |\n| `LIGO` | `ligo` | Peru | Pay-in |\n| `SIP` | `sip` | Peru, Bolivia | Pay-in |\n| `ACH` | `ach` | USA | Pay-in / Pay-out |\n| `WIRE` | `wire` | USA | Pay-out |\n| `FEDNOW` | `fedNow` | USA | Pay-in / Pay-out |\n| `RTP` | `rtp` | USA | Pay-in |\n| `SEPA` | `sepa` | Europe | Pay-out |\n| `FPE` | `fpe` | UK | Pay-out |\n| `SWIFT` | `swift` | Global | Pay-out |","enum":["CARD","CRYPTO","ACCOUNT","BANK_ACCOUNT","PIX","PCT","CVU","ETPAY","FINTOC","WEBPAY","SPEI","PSE","BANCOLOMBIA","DAVIVIENDA","DAVIPLATA","NEQUI","BREB","WOMPI","LIGO","SIP","ACH","WIRE","FEDNOW","RTP","SEPA","FPE","SWIFT"]},"currency":{"type":"string","description":"Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., `CLP`, `ARS`, `MXN`). Go to the [currencies page](../home/currencies \"mention\") for the complete list of supported values."},"fee":{"type":"object","description":"Details about any fees applied to the transaction.","properties":{"name":{"type":"string","description":"The name of the fee."},"type":{"description":"The type of fee applied (e.g., FIXED, PERCENTAGE).","$ref":"#/components/schemas/fee-type"},"value":{"type":"string","description":"The value of the fee."},"amount":{"type":"string","description":"The calculated amount of the fee."},"currency":{"$ref":"#/components/schemas/currency"}},"required":["name","type","value","currency","amount"]},"fee-type":{"type":"string","description":"Type of fee","enum":["FIXED","PERCENTAGE"]},"payment-node-base":{"description":"Shared base fields for payment nodes (`type`, `currency`, `amount`).","type":"object","properties":{"name":{"type":"string","description":"The name of the source or destination of the transaction."},"type":{"$ref":"#/components/schemas/payment-node-type"},"externalId":{"type":"string","description":"External reference identifier for integrations."},"amount":{"type":"string","description":"The amount involved in the transaction."},"amountOut":{"type":"string","description":"Calculated amount - fees"},"currency":{"$ref":"#/components/schemas/currency"},"settlement":{"type":"string","description":"Indicates the settlement period."},"fee":{"description":"Details about any fees applied to the transaction.","$ref":"#/components/schemas/fee"},"identity":{"type":"object","description":"The entity associated with the source or destination.","properties":{"name":{"type":"string","description":" The name of the entity (for users) or the official name (for organizations)."},"documentNumber":{"type":"string","description":"The document number associated with the entity for identification purposes."},"externalId":{"type":"string","description":"External reference ID (client purpose)."},"lastname":{"type":"string","description":"The last name of the user (if applicable)."}}},"metadata":{"type":"object","description":"Additional metadata related to the transaction source or destination.","properties":{"image":{"type":"string","description":"An image representing the source or destination."},"description":{"type":"string","description":"A brief description of the source or destination."},"category":{"type":"string","description":"The category or grouping of the source or destination."}},"required":["image","description","category"]}},"required":["type","currency"]},"node-wrapper":{"description":"Generic wrapper that holds one rail-specific node object.","discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/card-wrapper","ACCOUNT":"#/components/schemas/account-wrapper","CRYPTO":"#/components/schemas/crypto-wrapper","BANK_ACCOUNT":"#/components/schemas/bank-account-wrapper","PIX":"#/components/schemas/pix-wrapper","PCT":"#/components/schemas/pct-wrapper","ETPAY":"#/components/schemas/etpay-wapper","FINTOC":"#/components/schemas/fintoc-wrapper","WEBPAY":"#/components/schemas/webpay-wrapper","WOMPI":"#/components/schemas/wompi-wapper","PSE":"#/components/schemas/pse-wrapper","BANCOLOMBIA":"#/components/schemas/bancolombia-wrapper","DAVIVIENDA":"#/components/schemas/davivienda-wrapper","DAVIPLATA":"#/components/schemas/daviplata-wrapper","NEQUI":"#/components/schemas/nequi-wrapper","BREB":"#/components/schemas/breb-wrapper","CVU":"#/components/schemas/cvu-wrapper","SPEI":"#/components/schemas/spei-wrapper","LIGO":"#/components/schemas/ligo-wrapper","SIP":"#/components/schemas/sip-wrapper","ACH":"#/components/schemas/ach-wrapper","WIRE":"#/components/schemas/wire-wrapper","FEDNOW":"#/components/schemas/fednow-wrapper","RTP":"#/components/schemas/rtp-wrapper","SEPA":"#/components/schemas/sepa-wrapper","FPE":"#/components/schemas/fpe-wrapper","SWIFT":"#/components/schemas/swift-wrapper"}},"oneOf":[{"$ref":"#/components/schemas/card-wrapper"},{"$ref":"#/components/schemas/account-wrapper"},{"$ref":"#/components/schemas/bank-account-wrapper"},{"$ref":"#/components/schemas/crypto-wrapper"},{"$ref":"#/components/schemas/pix-wrapper"},{"$ref":"#/components/schemas/pct-wrapper"},{"$ref":"#/components/schemas/etpay-wapper"},{"$ref":"#/components/schemas/fintoc-wrapper"},{"$ref":"#/components/schemas/webpay-wrapper"},{"$ref":"#/components/schemas/wompi-wapper"},{"$ref":"#/components/schemas/pse-wrapper"},{"$ref":"#/components/schemas/bancolombia-wrapper"},{"$ref":"#/components/schemas/davivienda-wrapper"},{"$ref":"#/components/schemas/daviplata-wrapper"},{"$ref":"#/components/schemas/nequi-wrapper"},{"$ref":"#/components/schemas/breb-wrapper"},{"$ref":"#/components/schemas/cvu-wrapper"},{"$ref":"#/components/schemas/spei-wrapper"},{"$ref":"#/components/schemas/ligo-wrapper"},{"$ref":"#/components/schemas/sip-wrapper"},{"$ref":"#/components/schemas/ach-wrapper"},{"$ref":"#/components/schemas/wire-wrapper"},{"$ref":"#/components/schemas/fednow-wrapper"},{"$ref":"#/components/schemas/rtp-wrapper"},{"$ref":"#/components/schemas/sepa-wrapper"},{"$ref":"#/components/schemas/fpe-wrapper"},{"$ref":"#/components/schemas/swift-wrapper"}],"title":"subnode"},"card-wrapper":{"description":"Wrapper object exposing the `card` node payload.","type":"object","properties":{"card":{"type":"object","properties":{"holder":{"type":"string","description":"Card holder full name"},"scheme":{"type":"string","description":"Card scheme"},"type":{"type":"string","description":"Card type"},"mask":{"type":"string","description":"Last 4 digits"},"country":{"type":"string","description":"Issuing country"},"token":{"type":"string","description":"Card token"}},"required":["token"]}},"title":"CARD","required":["card"]},"account-wrapper":{"description":"Wrapper object exposing the internal `account` node payload.","type":"object","properties":{"account":{"type":"object","properties":{"type":{"description":"The type of internal account.","$ref":"#/components/schemas/account-type"},"currency":{"description":"The currency in which the internal account operates. Please check \"currencies\" page.","$ref":"#/components/schemas/currency"},"accountNumber":{"type":"string","description":"Internal reference number for the account."},"accountHolder":{"type":"string","description":"Name of the entity or user owning the internal account."}},"required":["type","currency","accountNumber","accountHolder"]}},"title":"ACCOUNT","required":["account"]},"account-type":{"type":"string","description":"The type of internal account.","enum":["CHECKING","ASSET","SAVINGS","ESCROW","FEE"]},"bank-account-wrapper":{"description":"Wrapper object exposing the external `bank` node payload.","type":"object","properties":{"bank":{"type":"object","properties":{"accountNumber":{"type":"string","description":"The bank account number."},"bank":{"type":"string","description":"The name of the bank where the account is held."},"currency":{"$ref":"#/components/schemas/currency"},"typeAccount":{"type":"string","description":"The type of bank account. CHECKING_ACOUNT, SAVINGS"},"accountHolder":{"type":"string","description":"The full name of the account holder."},"accountHolderDni":{"type":"string","description":"The national identification number or tax ID of the account holder."},"country":{"$ref":"#/components/schemas/country"}},"required":["accountNumber","bank","currency","accountHolder","accountHolderDni","country"]}},"title":"BANK_ACCOUNT","required":["bank"]},"country":{"type":"string","description":"Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., `CHL`, `USA`, `MEX`). Go to the [countries page](../home/countries \"mention\") for the complete list of supported values."},"crypto-wrapper":{"description":"Dedicated wrapper for CRYPTO nodes. Holds the `wallet` payload.","allOf":[{"$ref":"#/components/schemas/wallet-wrapper"}],"title":"CRYPTO"},"wallet-wrapper":{"description":"Wrapper object exposing the `wallet` node payload for crypto transfers.","type":"object","properties":{"wallet":{"type":"object","properties":{"provider":{"type":"string","description":"Optional wallet provider identifier (for routing/integration)."},"referenceId":{"type":"string","description":"Optional external wallet identifier in the provider system."},"token":{"type":"string","description":"Optional token symbol (e.g., `USDC`, `USDT`) when not implied by `currency`."},"network":{"type":"string","description":"Optional blockchain network (e.g., `ETH`, `TRON`, `SOLANA`)."},"address":{"type":"string","description":"Wallet's address"}},"required":["address"]}},"required":["wallet"],"title":"CRYPTO"},"pix-wrapper":{"description":"Wrapper object exposing the `pix` node payload.","type":"object","properties":{"pix":{"$ref":"#/components/schemas/pix"}},"required":["pix"],"title":"PIX"},"pix":{"description":"PIX rail payload for Brazil pay-ins and payouts.","type":"object","properties":{"data":{"type":"string","description":"The actual PIX code (EMV-compliant string) that represents the payment. This is what is known as the 'PIX' in Brazil and can be copied and pasted instead of scanning."},"qrCode":{"type":"string","description":"The rendered QR code string that can be scanned for PIX payments."},"expiredAt":{"type":"string","format":"date-time","description":"The expiration date and time of the QR code. UTC format."},"instructions":{"type":"string","description":"Optional instructions displayed to the user for completing the PIX payment."},"customer":{"type":"object","description":"Details of the customer initiating the payment.","properties":{"id":{"$ref":"#/components/schemas/_id"},"firstName":{"type":"string","description":"Payer's name"},"email":{"type":"string","description":"Payer's email"},"lastName":{"type":"string","description":"Payer's last name"},"phoneNumber":{"type":"string","description":"Payer's phone number without prefix"},"phoneNumberPrefix":{"type":"string","description":"Phone number prefix (e.g., +57)"},"documentType":{"$ref":"#/components/schemas/document-type"},"documentNumber":{"type":"string","description":"The document number associated with the documentType"},"address":{"$ref":"#/components/schemas/address"}},"required":["firstName"]},"successUrl":{"type":"string","description":"Redirect url in case of success"},"failedUrl":{"type":"string","description":"Redirect url in case of failure"}},"required":["data","customer"]},"_id":{"type":"string","description":"Unique identifier for the internal service."},"document-type":{"type":"string","description":"Documeny type of the entity (e.g., `RUT`, `CURP`, `CURL`). Go to the [Supported Identity document types page](../home/supported-identity-document-types \"mention\") for the complete list of supported values."},"address":{"type":"object","properties":{"administrativeAreaLevel1":{"type":"string","description":"The first-level administrative division."},"administrativeAreaLevel2":{"type":"string","description":"The second-level administrative division."},"administrativeAreaLevel3":{"type":"string","description":"The third-level administrative division."},"street":{"type":"string","description":"The name of the street."},"streetNumber":{"type":"string","description":"The street number."},"optionalAddress":{"type":"string","description":"Additional address details."},"country":{"$ref":"#/components/schemas/country"},"zipcode":{"type":"string","description":"Zipcode f the address"}},"description":"The entity’s address information."},"pct-wrapper":{"description":"Wrapper object exposing the `pct` node payload.","type":"object","properties":{"pct":{"$ref":"#/components/schemas/pct"}},"required":["pct"],"title":"PCT"},"pct":{"description":"PCT rail payload for Argentina QR pay-ins.","type":"object","properties":{"qrCode":{"type":"string","description":"The QR code string that can be rendered or scanned for interoperable transfer payments in Argentina under the BCRA's PCT (Transfer QR) standard."},"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect url in case of success"},"failedUrl":{"type":"string","description":"Redirect url in case of failure"}},"required":["customer"]},"customer":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"firstName":{"type":"string","description":"Payer's name"},"email":{"type":"string","description":"Payer's email"},"lastName":{"type":"string","description":"Payer's last name"},"phoneNumber":{"type":"string","description":"Payer's phone number without prefix"},"phoneNumberPrefix":{"type":"string","description":"Phone number prefix (e.g., +57)"},"documentType":{"$ref":"#/components/schemas/document-type"},"documentNumber":{"type":"string","description":"The document number associated with the documentType"},"address":{"$ref":"#/components/schemas/address"}},"description":"Information on who pays the transaction","required":["firstName"]},"etpay-wapper":{"description":"Wrapper object exposing the `etpay` node payload.","type":"object","properties":{"etpay":{"$ref":"#/components/schemas/etpay"}},"required":["etpay"],"title":"ETPAY"},"etpay":{"description":"Etpay open-banking payload for Chile pay-ins.","type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"url":{"type":"string"},"redirectUrl":{"type":"string","deprecated":true},"expiresAt":{"type":"string","format":"time"},"token":{"type":"string"},"signatureToken":{"type":"string"},"successUrl":{"type":"string","description":"Redirect url in case of success"},"failedUrl":{"type":"string","description":"Redirect url in case of failure"}}},"fintoc-wrapper":{"type":"object","description":"FINTOC pay-in node for Chile (CLP). Open banking pay-in via Fintoc widget.","properties":{"fintoc":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect URL on successful payment."},"failedUrl":{"type":"string","description":"Redirect URL on failed payment."}}}},"required":["fintoc"],"title":"FINTOC"},"webpay-wrapper":{"type":"object","description":"WEBPAY pay-in node for Chile (CLP). Card payments via Transbank.","properties":{"webpay":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect URL on successful payment."},"failedUrl":{"type":"string","description":"Redirect URL on failed payment."}},"required":["customer"]}},"required":["webpay"],"title":"WEBPAY"},"wompi-wapper":{"description":"Wrapper object exposing the `wompi` node payload.","type":"object","properties":{"wompi":{"$ref":"#/components/schemas/wompi"}},"title":"WOMPI"},"wompi":{"description":"Wompi gateway payload for Colombia pay-ins.","type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"url":{"type":"string"},"redirectUrl":{"type":"string"},"expiresAt":{"type":"string"},"token":{"type":"string"},"signatureToken":{"type":"string"}}},"pse-wrapper":{"type":"object","description":"PSE pay-in node for Colombia (COP). Online secure bank transfers.","properties":{"pse":{"type":"object","properties":{"bankId":{"type":"string","description":"Bank identifier for PSE transfer."},"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect URL on successful payment."},"failedUrl":{"type":"string","description":"Redirect URL on failed payment."}},"required":["bankId","customer"]}},"required":["pse"],"title":"PSE"},"bancolombia-wrapper":{"type":"object","description":"BANCOLOMBIA pay-in node for Colombia (COP). Bancolombia direct payment.","properties":{"bancolombia":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect URL on successful payment."},"failedUrl":{"type":"string","description":"Redirect URL on failed payment."}},"required":["customer"]}},"required":["bancolombia"],"title":"BANCOLOMBIA"},"davivienda-wrapper":{"type":"object","description":"DAVIVIENDA pay-in node for Colombia (COP). Davivienda direct payment.","properties":{"davivienda":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect URL on successful payment."},"failedUrl":{"type":"string","description":"Redirect URL on failed payment."}},"required":["customer"]}},"required":["davivienda"],"title":"DAVIVIENDA"},"daviplata-wrapper":{"type":"object","description":"DAVIPLATA pay-in/pay-out node for Colombia (COP). Daviplata mobile wallet.","properties":{"daviplata":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect URL on successful payment."},"failedUrl":{"type":"string","description":"Redirect URL on failed payment."}},"required":["customer"]}},"required":["daviplata"],"title":"DAVIPLATA"},"nequi-wrapper":{"type":"object","description":"NEQUI pay-in/pay-out node for Colombia (COP). Nequi digital wallet.","properties":{"nequi":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect URL on successful payment."},"failedUrl":{"type":"string","description":"Redirect URL on failed payment."}},"required":["customer"]}},"required":["nequi"],"title":"NEQUI"},"breb-wrapper":{"type":"object","description":"BREB pay-out node for Colombia (COP). Bank account transfer payout.","properties":{"breb":{"type":"object","properties":{"bankId":{"type":"string","description":"Bank identifier for the recipient's account."},"accountNumber":{"type":"string","description":"Recipient's bank account number."},"accountType":{"type":"string","description":"Account type (CHECKING or SAVINGS).","enum":["CHECKING","SAVINGS"]},"customer":{"$ref":"#/components/schemas/customer"}},"required":["bankId","accountNumber","customer"]}},"required":["breb"],"title":"BREB"},"cvu-wrapper":{"type":"object","description":"CVU pay-in node for Argentina (ARS). Virtual account / CBU bank transfers.","properties":{"cvu":{"type":"object","properties":{"code":{"type":"string","description":"Optional CVU/CBU code when pre-assigned by the payer flow."},"customer":{"$ref":"#/components/schemas/customer"}}}},"required":["cvu"],"title":"CVU"},"spei-wrapper":{"type":"object","description":"SPEI pay-in/pay-out node for Mexico (MXN). Electronic Interbank Payment System.","properties":{"spei":{"type":"object","properties":{"clabe":{"type":"string","description":"CLABE (18-digit interbank code) of the recipient. Required for pay-out."},"customer":{"$ref":"#/components/schemas/customer"}},"required":["customer"]}},"required":["spei"],"title":"SPEI"},"ligo-wrapper":{"type":"object","description":"LIGO pay-in node for Peru (PEN). QR-based payment system.","properties":{"ligo":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect URL on successful payment."},"failedUrl":{"type":"string","description":"Redirect URL on failed payment."}},"required":["customer"]}},"required":["ligo"],"title":"LIGO"},"sip-wrapper":{"type":"object","description":"SIP pay-in node for Peru (PEN) and Bolivia (BOB). Interoperable payment system.","properties":{"sip":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/customer"},"successUrl":{"type":"string","description":"Redirect URL on successful payment."},"failedUrl":{"type":"string","description":"Redirect URL on failed payment."}},"required":["customer"]}},"required":["sip"],"title":"SIP"},"ach-wrapper":{"type":"object","description":"ACH pay-in/pay-out node for USA (USD). Automated Clearing House bank transfers.","properties":{"ach":{"type":"object","properties":{"routingNumber":{"type":"string","description":"ABA routing number (9 digits)."},"accountNumber":{"type":"string","description":"Bank account number."},"accountType":{"type":"string","description":"Account type (CHECKING or SAVINGS).","enum":["CHECKING","SAVINGS"]},"customer":{"$ref":"#/components/schemas/customer"}},"required":["routingNumber","accountNumber","customer"]}},"required":["ach"],"title":"ACH"},"wire-wrapper":{"type":"object","description":"WIRE pay-out node for USA (USD). Wire transfer via correspondent banks.","properties":{"wire":{"type":"object","properties":{"swiftCode":{"type":"string","description":"SWIFT/BIC code of the recipient's bank."},"routingNumber":{"type":"string","description":"ABA routing number (9 digits)."},"accountNumber":{"type":"string","description":"Recipient's bank account number."},"bankName":{"type":"string","description":"Name of the recipient's bank."},"customer":{"$ref":"#/components/schemas/customer"}},"required":["swiftCode","accountNumber","customer"]}},"required":["wire"],"title":"WIRE"},"fednow-wrapper":{"type":"object","description":"FEDNOW pay-in/pay-out node for USA (USD). FedNow instant payment service.","properties":{"fedNow":{"type":"object","properties":{"routingNumber":{"type":"string","description":"ABA routing number (9 digits)."},"accountNumber":{"type":"string","description":"Bank account number."},"accountType":{"type":"string","description":"Account type (CHECKING or SAVINGS).","enum":["CHECKING","SAVINGS"]},"customer":{"$ref":"#/components/schemas/customer"}},"required":["routingNumber","accountNumber","customer"]}},"required":["fedNow"],"title":"FEDNOW"},"rtp-wrapper":{"type":"object","description":"RTP pay-in node for USA (USD). Real-time payments network.","properties":{"rtp":{"type":"object","properties":{"routingNumber":{"type":"string","description":"ABA routing number (9 digits)."},"accountNumber":{"type":"string","description":"Bank account number."},"accountType":{"type":"string","description":"Account type (CHECKING or SAVINGS).","enum":["CHECKING","SAVINGS"]},"customer":{"$ref":"#/components/schemas/customer"}},"required":["routingNumber","accountNumber","customer"]}},"required":["rtp"],"title":"RTP"},"sepa-wrapper":{"type":"object","description":"SEPA pay-out node for Europe (EUR). Single Euro Payments Area transfers.","properties":{"sepa":{"type":"object","properties":{"iban":{"type":"string","description":"Recipient's IBAN."},"bic":{"type":"string","description":"BIC/SWIFT code of the recipient's bank."},"customer":{"$ref":"#/components/schemas/customer"}},"required":["iban","customer"]}},"required":["sepa"],"title":"SEPA"},"fpe-wrapper":{"type":"object","description":"FPE pay-out node for UK (GBP). Faster Payments — near-instant bank transfers.","properties":{"fpe":{"type":"object","properties":{"accountNumber":{"type":"string","description":"UK bank account number (8 digits)."},"sortCode":{"type":"string","description":"Sort code (6 digits, e.g., \"200415\")."},"customer":{"$ref":"#/components/schemas/customer"}},"required":["accountNumber","sortCode","customer"]}},"required":["fpe"],"title":"FPE"},"swift-wrapper":{"type":"object","description":"SWIFT pay-out node for international transfers. Multi-currency global bank wire.","properties":{"swift":{"type":"object","properties":{"swiftCode":{"type":"string","description":"SWIFT/BIC code of the recipient's bank."},"iban":{"type":"string","description":"Recipient IBAN when destination country requires it (typically SEPA zone)."},"bank":{"type":"object","description":"Recipient bank account details.","properties":{"accountNumber":{"type":"string","description":"Recipient's bank account number."},"name":{"type":"string","description":"Name of the recipient's bank."}},"required":["accountNumber"]},"customer":{"description":"Beneficiary identity data required by correspondent banks.","allOf":[{"$ref":"#/components/schemas/customer"},{"type":"object","required":["firstName","lastName","email","documentNumber","documentType"]}]}},"required":["swiftCode","bank","customer"]}},"required":["swift"],"title":"SWIFT"},"payment":{"type":"object","description":"Schema representing a financial transaction, including details about the transaction's origins, destinations, amounts, fees, and status.","properties":{"id":{"$ref":"#/components/schemas/_id"},"externalId":{"type":"string","description":"External reference identifier for integrations."},"identityId":{"type":"string","description":"Identifier linking the transaction to a specific user or organization."},"identityExternalId":{"type":"string","description":"External reference identifier for the identity associated with the transaction."},"accountNumber":{"type":"string","description":"The account number involved in the transaction."},"totalAmount":{"type":"string","description":"The total amount of the transaction."},"currency":{"$ref":"#/components/schemas/currency"},"description":{"type":"string","description":"A brief description of the transaction."},"product":{"type":"string","description":"The product or service related to the transaction. purchaseCurrency:Currency"},"status":{"type":"string","description":"The current status of the transaction (e.g., PENDING, AUTHORIZED, CAPTURED, ATTEMPT, REFUNDED)."},"type":{"$ref":"#/components/schemas/payment-type"},"purchaseAmount":{"type":"string","description":"The amount paid in the transaction."},"purchaseCurrency":{"$ref":"#/components/schemas/currency"},"fees":{"type":"array","description":"A list of fees associated with the transaction.","items":{"$ref":"#/components/schemas/fee"}},"createdAt":{"type":"string","description":"Timestamp indicating when the transaction was created."},"updatedAt":{"type":"string","description":"Timestamp indicating the last update to the transaction."},"expiresAt":{"type":"string","description":"Timestamp indicating when the transaction expires, if applicable."},"capturedAt":{"type":"string","description":"Timestamp indicating when the transaction was captured."},"authorizedAt":{"type":"string","description":"Timestamp indicating when the transaction was authorized."},"refundedAt":{"type":"string","description":"Timestamp indicating when the transaction was refunded, if applicable."},"origins":{"type":"array","description":"A list of sources for the transaction.","items":{"$ref":"#/components/schemas/payment-node"}},"destinations":{"type":"array","description":"A list of destinations for the transaction.","items":{"$ref":"#/components/schemas/payment-node"}},"settlement":{"type":"string","description":"Settlement period for the transaction."}},"required":["id","externalId","identityId","accountNumber","totalAmount","currency","status","type","createdAt","updatedAt"]},"payment-type":{"type":"string","description":"Indicates the purpose of the payment.\nThis field defines how the payment should be processed within the system, based on its intent—such as funding an account, withdrawing funds, transferring between users, collecting funds, or applying fees.\nGo to the [payment types page](../payments/payment-types \"mention\") for the complete list of supported values.","enum":["PURCHASE","TOPUP_ACCOUNT","WITHDRAWAL_ACCOUNT","P2P","COLLECT","FEE","REMITTANCE"]},"error":{"type":"object","description":"Standard error response payload.","properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"error":{"type":"string","description":"Error category."},"message":{"type":"string","description":"Human-readable error message."}},"required":["statusCode","error","message"]}},"responses":{"Bad request":{"description":"The request is invalid, malformed, or contains unsupported values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Internal server error":{"description":"The server failed to process the request due to an unexpected condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/checkout-sessions/{checkout_session_id}/payments":{"post":{"summary":"Create Payment from checkout session","deprecated":false,"description":"When creating a transaction from a checkout session, this endpoint provides a payment method and a provider system to process the payment.","operationId":"create-checkout-session-payment","tags":["Checkout-sessions"],"parameters":[{"name":"checkout_session_id","in":"path","description":"Unique identifier of the checkout session where the payment is submitted.","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","description":"The API key used for authentication when making requests to the API Gateway.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Identifies the application making the request.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/checkout-session-payment"}}}},"responses":{"200":{"description":"Request processed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payment"}}},"headers":{}},"400":{"$ref":"#/components/responses/Bad request","description":"Invalid request parameters or payload."},"500":{"$ref":"#/components/responses/Internal server error","description":"Unexpected internal server error."}}}}}} ``` ## Create checkout session from payment-link > Creates a checkout session from a payment-link checkout token. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Payment-links"},{"name":"internal"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}},"schemas":{"checkout-session":{"description":"Checkout session entity created from a payment link or token.","type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"paymentLinkId":{"type":"string","description":"Reference Payment Link ID"},"checkoutToken":{"type":"string","description":"Reference for checkout url"},"paymentConfigs":{"type":"array","items":{"$ref":"#/components/schemas/currency-config"}},"createdAt":{"type":"string","description":"When the link expires ","format":"date-time"},"status":{"description":"Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated","$ref":"#/components/schemas/checkout-session-status"},"items":{"type":"array","items":{"type":"object","properties":{"preTaxAmount":{"type":"string","description":"The amount of the item"},"totalAmount":{"type":"string","description":"amount + tax.amount, if no tax it's equal to amount"},"description":{"type":"string","description":"The description of the item"},"tax":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fee."},"type":{"description":"The type of fee applied (e.g., FIXED, PERCENTAGE).","$ref":"#/components/schemas/fee-type"},"value":{"type":"string","description":"The value of the fee."},"amount":{"type":"string","description":"The calculated amount of the fee."}},"required":["name","type","value","amount"],"nullable":true}},"required":["preTaxAmount","totalAmount","description"]},"description":"List of items to pay for"},"currency":{"$ref":"#/components/schemas/currency","description":"Currency for payment"},"preTaxAmount":{"type":"string","description":"Addition of all items preTaxAmounts"},"totalAmount":{"type":"string","description":"Addition of all items totalAmounts"},"url":{"type":"string","description":"Url to open checkout flow"},"paymentMethodsAllowed":{"type":"array","items":{"$ref":"#/components/schemas/payment-node-type"},"description":"Allowed payment methods.","minItems":1},"customer":{"description":"Optional customer to pass into the checkout session","type":"object","properties":{"id":{"$ref":"#/components/schemas/_id"},"firstName":{"type":"string","description":"Payer's name"},"email":{"type":"string","description":"Payer's email"},"lastName":{"type":"string","description":"Payer's last name"},"phoneNumber":{"type":"string","description":"Payer's phone number without prefix"},"phoneNumberPrefix":{"type":"string","description":"Phone number prefix (e.g., +57)"},"documentType":{"$ref":"#/components/schemas/document-type"},"documentNumber":{"type":"string","description":"The document number associated with the documentType"},"address":{"$ref":"#/components/schemas/address"}},"nullable":true},"redirectUrl":{"type":"string","description":"The URL to which the end user will be redirected after completing the payment. "},"destinations":{"type":"array","items":{"$ref":"#/components/schemas/payment-link-destination"},"description":"A list of destinations for the transaction.","minItems":1},"customerRequirements":{"type":"array","items":{"type":"string","description":"customer fields to require on checkout","enum":["firstName","email","lastName","phoneNumber","phoneNumberPrefix","address","documentNumber","documentType"]}},"expiresAt":{"type":"string","format":"date-time"},"owner":{"$ref":"#/components/schemas/node-identity","description":"owner of who created the session"}},"required":["id","createdAt","paymentConfigs","paymentMethodsAllowed","items","url","currency","destinations","status","preTaxAmount","totalAmount","expiresAt","owner"]},"_id":{"type":"string","description":"Unique identifier for the internal service."},"currency-config":{"description":"Currency-level checkout configuration for available payment methods.","type":"object","properties":{"currency":{"type":"string","description":"Currency code enabled for the checkout session"},"product":{"type":"string","description":"Product conversion of the checkout session"},"exchangeRate":{"type":"string","description":"Product's exchange rate"},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/payment-method-config"},"description":"Payment methods config list"}},"required":["currency","product","exchangeRate","paymentMethods"]},"payment-method-config":{"description":"Payment-method configuration and limits for a checkout session.","type":"object","properties":{"id":{"type":"string","description":"ID specific type of Payment method"},"type":{"type":"string","description":"Generic type of Payment method"},"enabled":{"type":"boolean","description":"Enabled boolean"},"requiredFields":{"type":"array","items":{"type":"string"},"description":"List of required fields for the provider"},"purchaseAmount":{"type":"string","description":"Calculated amount to pay for the Payment Method"}},"required":["id","type","enabled","requiredFields","purchaseAmount"]},"checkout-session-status":{"type":"string","description":"checkout session status","enum":["ATTEMPT","ACTIVE","EXPIRED","FINISHED","PROCESSING_PAYMENT","FAILED"]},"fee-type":{"type":"string","description":"Type of fee","enum":["FIXED","PERCENTAGE"]},"currency":{"type":"string","description":"Specifies the currency used, following the ISO 4217 standard for fiat currencies (e.g., `CLP`, `ARS`, `MXN`). Go to the [currencies page](../home/currencies \"mention\") for the complete list of supported values."},"payment-node-type":{"type":"string","description":"Defines the source or destination type of the payment. This field determines how the funds will be sent or received and which structure is expected in the corresponding `node` object. Only one type is allowed per node.\n\n| Type | Node | Country | Direction |\n|---------------|---------------|----------------|------------------|\n| `CARD` | `card` | Multi | Pay-in |\n| `CRYPTO` | `wallet` | Multi | Pay-in / Pay-out |\n| `ACCOUNT` | `account` | Multi | Pay-in / Pay-out |\n| `BANK_ACCOUNT`| `bank` | Multi | Pay-out |\n| `PIX` | `pix` | Brazil | Pay-in / Pay-out |\n| `PCT` | `pct` | Argentina | Pay-in |\n| `CVU` | `cvu` | Argentina | Pay-in |\n| `ETPAY` | `etpay` | Chile | Pay-in |\n| `FINTOC` | `fintoc` | Chile | Pay-in |\n| `WEBPAY` | `webpay` | Chile | Pay-in |\n| `SPEI` | `spei` | Mexico | Pay-in / Pay-out |\n| `PSE` | `pse` | Colombia | Pay-in |\n| `BANCOLOMBIA` | `bancolombia` | Colombia | Pay-in |\n| `DAVIVIENDA` | `davivienda` | Colombia | Pay-in |\n| `DAVIPLATA` | `daviplata` | Colombia | Pay-in / Pay-out |\n| `NEQUI` | `nequi` | Colombia | Pay-in / Pay-out |\n| `BREB` | `breb` | Colombia | Pay-out |\n| `WOMPI` | `wompi` | Colombia | Pay-in |\n| `LIGO` | `ligo` | Peru | Pay-in |\n| `SIP` | `sip` | Peru, Bolivia | Pay-in |\n| `ACH` | `ach` | USA | Pay-in / Pay-out |\n| `WIRE` | `wire` | USA | Pay-out |\n| `FEDNOW` | `fedNow` | USA | Pay-in / Pay-out |\n| `RTP` | `rtp` | USA | Pay-in |\n| `SEPA` | `sepa` | Europe | Pay-out |\n| `FPE` | `fpe` | UK | Pay-out |\n| `SWIFT` | `swift` | Global | Pay-out |","enum":["CARD","CRYPTO","ACCOUNT","BANK_ACCOUNT","PIX","PCT","CVU","ETPAY","FINTOC","WEBPAY","SPEI","PSE","BANCOLOMBIA","DAVIVIENDA","DAVIPLATA","NEQUI","BREB","WOMPI","LIGO","SIP","ACH","WIRE","FEDNOW","RTP","SEPA","FPE","SWIFT"]},"document-type":{"type":"string","description":"Documeny type of the entity (e.g., `RUT`, `CURP`, `CURL`). Go to the [Supported Identity document types page](../home/supported-identity-document-types \"mention\") for the complete list of supported values."},"address":{"type":"object","properties":{"administrativeAreaLevel1":{"type":"string","description":"The first-level administrative division."},"administrativeAreaLevel2":{"type":"string","description":"The second-level administrative division."},"administrativeAreaLevel3":{"type":"string","description":"The third-level administrative division."},"street":{"type":"string","description":"The name of the street."},"streetNumber":{"type":"string","description":"The street number."},"optionalAddress":{"type":"string","description":"Additional address details."},"country":{"$ref":"#/components/schemas/country"},"zipcode":{"type":"string","description":"Zipcode f the address"}},"description":"The entity’s address information."},"country":{"type":"string","description":"Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., `CHL`, `USA`, `MEX`). Go to the [countries page](../home/countries \"mention\") for the complete list of supported values."},"payment-link-destination":{"description":"Destination configuration schema used by payment links.","allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the source or destination of the transaction."},"type":{"$ref":"#/components/schemas/payment-node-type"},"externalId":{"type":"string","description":"External reference identifier for integrations."},"amount":{"type":"string","description":"The amount involved in the transaction."},"metadata":{"type":"object","description":"Additional metadata related to the transaction source or destination.","properties":{"image":{"type":"string","description":"An image representing the source or destination."},"description":{"type":"string","description":"A brief description of the source or destination."},"category":{"type":"string","description":"The category or grouping of the source or destination."}},"required":["image","description","category"]}},"required":["type","amount"]},{"$ref":"#/components/schemas/account-wrapper"},{"properties":{"type":{"type":"string","enum":["ACCOUNT"]}},"required":["type"],"type":"object"}]},"account-wrapper":{"description":"Wrapper object exposing the internal `account` node payload.","type":"object","properties":{"account":{"type":"object","properties":{"type":{"description":"The type of internal account.","$ref":"#/components/schemas/account-type"},"currency":{"description":"The currency in which the internal account operates. Please check \"currencies\" page.","$ref":"#/components/schemas/currency"},"accountNumber":{"type":"string","description":"Internal reference number for the account."},"accountHolder":{"type":"string","description":"Name of the entity or user owning the internal account."}},"required":["type","currency","accountNumber","accountHolder"]}},"title":"ACCOUNT","required":["account"]},"account-type":{"type":"string","description":"The type of internal account.","enum":["CHECKING","ASSET","SAVINGS","ESCROW","FEE"]},"node-identity":{"description":"Identity reference object used inside account nodes.","type":"object","properties":{"identityId":{"type":"string","description":"User unique identifier"},"name":{"type":"string","description":"User name"},"lastname":{"type":"string","description":"User lastname"},"nickname":{"type":"string","description":"User nickname"},"documentNumber":{"type":"string","description":"User DNI"},"entityType":{"type":"string","description":"Entity type of identity"}},"additionalProperties":false,"required":["identityId"]},"error":{"type":"object","description":"Standard error response payload.","properties":{"statusCode":{"type":"integer","description":"HTTP status code."},"error":{"type":"string","description":"Error category."},"message":{"type":"string","description":"Human-readable error message."}},"required":["statusCode","error","message"]}},"responses":{"Bad request":{"description":"The request is invalid, malformed, or contains unsupported values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Internal server error":{"description":"The server failed to process the request due to an unexpected condition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/payment-links/token/{checkout-token}/checkout-sessions":{"post":{"summary":"Create checkout session from payment-link","deprecated":false,"description":"Creates a checkout session from a payment-link checkout token.","operationId":"create-checkout-payment-link","tags":["Payment-links","internal"],"parameters":[{"name":"checkout-token","in":"path","description":"Checkout token that identifies the payment link session context.","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","description":"The API key used for authentication when making requests to the API Gateway.","required":true,"schema":{"type":"string"}},{"name":"User-Agent","in":"header","description":"Identifies the application making the request.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"201":{"description":"Resource created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/checkout-session"}}},"headers":{}},"400":{"$ref":"#/components/responses/Bad request","description":"Invalid request parameters or payload."},"500":{"$ref":"#/components/responses/Internal server error","description":"Unexpected internal server error."}}}}}} ```