--- title: "Create Checkout" method: POST path: "/checkout" tags: ["Checkout"] --- # Create Checkout `POST /checkout` Creates a Checkout Session. **Required scope:** checkout:create ## Request body - CheckoutRequest - `type` CheckoutPaymentTypesRequest[], required — Only the first value in the Array is considered (e.g. ['single', 'frequent'] would be equivalent to ['single']). - `payment` CheckoutPaymentObjectRequest, required - `methods` string[] — All the payment methods available to create a checkout payment. - `type` 'sale' | 'authorisation' — Specifies the type of financial operation being performed.
**This property is used only for Single Payments.** TYPE | DESCRIPTION | ---------|----------| sale | a complete transaction where funds are immediately captured. | authorisation | a temporary hold on funds pending a future capture. | - `capture` CheckoutCaptureObjectRequest - `transaction_key` string — The internal key used to identify this transaction in the merchant's database. - `capture_date` string, date — The date on which the capture is performed. - `account` object — This object is used for multi-account clients. - `id` string, uuid — The uuid of the account. - `splits` CaptureSplitCreate — Represents a split configuration for dividing transaction funds across multiple accounts. This is useful for marketplace or multi-vendor scenarios where transaction proceeds need to be distributed. - `split_key` string — A customizable text field for users to input their own identifier for the split. - `split_descriptive` string — A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as "Payment of Invoice Nº 1982652" or "Ticket for Queen". - `account` object — The account to receive the split funds - `id` string, required - `value` number, double, required — The monetary amount for the transaction. This field specifies the value of the payment in the designated currency. It must be a positive decimal number representing the exact amount to be processed. - `clearing_period` string — The clearing period must follow the format 1Y, 10W or 30D. Y for Years, W for weeks, D for days. Minimum is 7 days, maximum is 1 year. - `margin_account` object — The account to which the margin value should be routed. This field specifies the destination account for the margin portion of the funds, ensuring that the correct recipient receives the designated margin value. - `id` string, required - `margin_value` number, double — The margin amount to be deducted from this split - `reward` object — Reward credits to generate from this split. The credits are associated with the customer provided at the top level of the payment request and can only be redeemed by that customer. Reward funds expire after the specified period. See the [Rewards & Redemptions guide](/docs/guides/rewards-and-redemptions) for the full flow. - `account` object, required — The account to which the reward credits should be routed. - `id` string, required - `value` number, double, required — The reward amount to be generated from this split. - `expiration_date` string, date — The date until which the reward credits are valid. Defaults to 12 months from the transaction date if not specified. - `descriptive` string — Required if the payment method is 'MBW'. - `sdd_mandate` SddMandate — The SDD Mandate object contains the necessary fields to create a SEPA Direct Debit mandate. This object ensures that all required information is provided to authorize and process SEPA Direct Debit transactions. Object required when method is Direct Debit. - `iban` string, required — The International Bank Account Number (IBAN) of the debtor's account. This field is used to uniquely identify the debtor's bank account across international borders, ensuring accurate and efficient processing of SEPA Direct Debit transactions. The IBAN is a standardized format that includes the country code, check digits, bank code, and account number. - `key` string — A customizable text field for users to input their own identifier for the SDD mandate. - `name` string, required — Full name of the account holder as it appears on the bank account. - `email` string, email, required — Email address of the account holder for mandate-related communications. - `phone` string, required — Phone number of the account holder without country code. - `account_holder` string, required — The name of the person or entity that holds the bank account. This field is used to identify the owner of the bank account involved in the transaction, ensuring that the correct account is credited or debited. - `country_code` string — ISO 3166-1 alpha-2 country code of the customer's country. - `max_num_debits` string — Maximum number of debits allowed under this mandate. - `billing_entity` string — The entity responsible for billing in the context of the SEPA Direct Debit (SDD) mandate. - `expiration_time` string, date — The last possible time to make the payment. Applicable in Multibanco payments. Note: If the expiration time is less than the default checkout session expiration (which is 30 minutes), the user won't be able to interact with the Checkout after that time. - `currency` string — The currency code in ISO 4217 format (e.g., "EUR" for Euro). This field specifies the type of currency used in financial operation. - `key` string — The merchant's key for identifying the payment. - `max_value` number, double — Additional property for frequent payments. - `min_value` number, double — Additional property for frequent payments. - `unlimited_payments` boolean — Additional property for frequent payments. - `frequency` '1D' | '1W' | '2W' | '1M' | '2M' | '3M' | '4M' | '6M' | '1Y' | '2Y' | '3Y' — Additional property for subscription payments. - `max_captures` integer — Additional property for subscription payments. Defines a maximum number of captures, is required when no expiration_time is set. - `start_time` string, date — Additional property for subscription payments. Defines the start of the billing cycles. - `failover` boolean — Additional property for subscription payments. After all retries failed, the payment cycle can have another try with another single method. - `capture_now` boolean — Additional property for subscription payments. Whether to schedule an immediate capture and schedule the second one for start_time. - `retries` number — Additional property for subscription payments. Number of retries in each payment cycle.
The chosen frequency will define the max number of possible retries. - `multibanco` object — An object that holds the details specific to a Multibanco transaction. **This property is used only for Single Payments.** - `expiration_time` string, required — The end timestamp indicating the deadline by which the Multibanco Reference must be paid. It defines the final time within which the payment must be completed. The format follows RFC3339 (e.g., "2024-06-30T21:38:31Z"). - `start_time` string — The starting timestamp indicating when the Multibanco Reference becomes valid for payment. It defines the initial time from which the payment can be made. The format follows RFC3339 (e.g., "2024-06-30T21:38:31Z"). This field is optional and defaults to the current timestamp if not specified, or if the sent value is in the past. - `multibanco` object — An object that holds the details specific to a Multibanco transaction. - `expiration_time` string, date-time, required — The end timestamp indicating the deadline by which the Multibanco Reference must be paid. It defines the final time within which the payment must be completed. The format follows RFC3339 (e.g., "2024-06-30T21:38:31Z"). - `start_time` string, date-time — The starting timestamp indicating when the Multibanco Reference becomes valid for payment. It defines the initial time from which the payment can be made. The format follows RFC3339 (e.g., "2024-06-30T21:38:31Z"). This field is optional and defaults to the current timestamp if not specified, or if the sent value is in the past. - `product` 'FILE' | 'SPG' | 'CHECKDIGIT' — This field is used to select the desired product. Below, the supported features for each product are listed. The default value is CHECKDIGIT. Additional costs may apply depending on the selected product. **Product Features:** | Product Type | Immediate Issuance | Expiration Date | Start Date | |--------------|-------------------|-----------------|------------| | CHECKDIGIT | ✓ | ✓ | ✗ | | SPG | ✗ | ✓ | ✓ | | FILE | ✗ | ✓ | ✓ | **Descriptions:** - **CHECKDIGIT**: Standard Multibanco references with immediate issuance - **SPG**: Special purpose group references with scheduling capabilities - **FILE**: File-based references for batch processing - `notification` Notification — Notification settings for payment methods. - `customer_method_instructions_email` boolean — Specifies whether an email containing the payment instructions (e.g., Multibanco reference or Virtual IBAN details) should be sent to the customer's email address when the selected payment method is Multibanco or Virtual IBAN. - `order` CheckoutOrderResponse - `items` object[] - `description` string, required — Brief description of the item. - `quantity` number — Quantity of this item being paid. - `key` string — The merchant's key to identify the item - `value` number, double, required — The price being paid for the specific item(s), rounded to 2 decimals. - `key` string — The merchant's key to identify the order. - `value` number, double, required — The price being paid for the entire order, rounded to 2 decimals - `customer` CheckoutCustomerRequest — The Customer object contains detailed information about the customer required to create a Checkout payment. - `id` string, uuid — A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced. - `name` string — The full name of the customer. This field is used to identify the customer and personalize interactions. It typically includes the customer's first name and last name. - `email` string, email — The email address of the customer. This field is used for communication purposes, including sending transaction confirmations, receipts, and other notifications related to the customer's activities. - `phone` string — The contact phone number of the customer has the E.164 pattern. This number will be used to make the payment if the method is MB WAY. - `phone_indicative` string — The phone country code. - `language` string — The language preference of the customer, specified in the ISO 639-1 Alpha-2 format (e.g., "EN" for English, "PT" for Portuguese). This field is used to indicate the customer's preferred language for communication and documentation. - `fiscal_number` string — The customer's fiscal number (prefixed by the country code). - `key` string — The merchant's key to identify the customer. ## Response `201` Created - CheckoutPostResponse — The response body when the checkout is created successfully. - `id` string, uuid — UUID of the checkout. - `session` string — Session token to be used by the rest of the Checkout process. - `config` unknown ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.net/easypay/apis/easypay-payments-api.md) · [All operations](https://skmtc.net/easypay/apis/easypay-payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/easypay/easypay-payments-api/versions/cdf25a9ad7b2/schema)