> ## Documentation Index > Fetch the complete documentation index at: https://docs.augustus.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers. > Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required. > Cite or link the relevant docs.augustus.com page when answering integration questions. > Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation. > Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key. > The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions. # Create a Checkout Session > Creates a Checkout Session for the merchant corresponding to the given API key. See [the guide](https://docs.getivy.de/docs/payment-integration) for more information. ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/getivy/openapi.documented.yml post /api/service/checkout/session/create openapi: 3.0.0 info: title: Ivy API description: Ivy API schema version: '1.0' contact: name: Ivy url: https://www.getivy.io email: help@getivy.io servers: - url: https://api.getivy.de description: Production - url: https://api.sand.getivy.de description: Sandbox security: [] tags: [] paths: /api/service/checkout/session/create: post: tags: - Checkout summary: Create a Checkout Session description: >- Creates a Checkout Session for the merchant corresponding to the given API key. See [the guide](https://docs.getivy.de/docs/payment-integration) for more information. operationId: CheckoutSessionController_create parameters: - name: Idempotency-Key in: header description: >- Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409. required: false schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CheckoutSessionCreateInputDto' responses: '200': description: Returns the created checkout session content: application/json: schema: $ref: '#/components/schemas/ExternalCheckoutSessionResponseDto' security: - ApiKeyAuth: [] x-codeSamples: - lang: JavaScript source: |- import Ivy from '@getivy/node-sdk'; const client = new Ivy({ apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted }); const checkoutsession = await client.checkoutsession.create({ price: { currency: 'EUR', total: 1.01 }, referenceId: 'referenceId', }); console.log(checkoutsession.id); components: schemas: CheckoutSessionCreateInputDto: type: object properties: express: description: Sets the checkout to a express version type: boolean default: false paymentMode: description: >- The mode in which the payment should be processed. If direct is used, you need to provide a settlementDestination type: string enum: - direct - settlement x-enumNames: - Direct - Settlement settlementDestination: type: object properties: reference: type: string financialAddress: type: object properties: type: type: string enum: - iban - sort_code - bank_code - bban - wallet - aba x-enumNames: - IBAN - SORT_CODE - BANK_CODE - BBAN - WALLET - ABA iban: type: object properties: accountHolderName: type: string minLength: 1 iban: type: string bic: type: string required: - accountHolderName - iban aba: type: object properties: accountHolderName: type: string minLength: 1 routingNumber: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ required: - accountHolderName - routingNumber - accountNumber sortCode: type: object properties: accountHolderName: type: string minLength: 1 sortCode: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ maxLength: 8 required: - accountHolderName - sortCode - accountNumber bankCode: type: object properties: accountHolderName: type: string minLength: 1 code: type: string accountNumber: type: string required: - accountHolderName - code - accountNumber bban: type: object properties: accountHolderName: type: string minLength: 1 bban: type: string bic: type: string required: - accountHolderName - bban wallet: type: object properties: address: description: The blockchain wallet address type: string blockchain: description: The blockchain network type: string enum: - BTC - BTC-TESTNET4 - ETH - ETH-SEPOLIA - SOL - SOL-DEVNET - MATIC - MATIC-AMOY required: - address - blockchain required: - type bankAddress: description: >- Physical address of the bank that holds the settlement account. Must match the address of the financial institution associated with the provided account details. type: object properties: line1: type: string minLength: 1 maxLength: 200 pattern: ^[\p{L}\p{N}\s\-.,'#/&()°ªº№:;]+$ line2: type: string region: type: string maxLength: 80 pattern: ^[\p{L}\p{N}\s.'\-(),/&]*$ city: type: string minLength: 1 maxLength: 150 pattern: ^[\p{L}\p{M}\p{N}\s\-'.(),&°ªº№:;]+$ zipCode: type: string minLength: 1 maxLength: 30 pattern: ^[\p{L}\p{N}\s\-./]+$ country: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK required: - line1 - city - zipCode - country required: - reference referenceId: description: >- An internal reference id which will be stored with the order. Needs to be unique per shop and can be up to 200 characters. type: string maxLength: 200 displayId: description: >- The order id which will be displayed to the user and in the merchant dashboard. At most 200 characters are allowed. type: string maxLength: 200 metadata: description: >- Any data which will be stored and returned for this checkout session and corresponding order type: object additionalProperties: {} price: description: Price of the checkout session type: object properties: total: type: number minimum: 0.01 exclusiveMinimum: false currency: type: string enum: - EUR - USD - GBP - PLN - SEK - DKK x-enumNames: - EUR - USD - GBP - PLN - SEK - DKK subTotal: type: number shipping: type: number totalNet: type: number vat: type: number required: - total - currency lineItems: description: >- All line items of this checkout session. At least one line item required type: array minItems: 1 items: type: object properties: name: description: Customer-facing name of the line item. type: string referenceId: description: An internal unique id stored to this line item. type: string singleNet: type: number singleVat: type: number amount: description: >- Accumulated cost in decimals. For example, for a lineItem with total price 3.00 and quantity 4, amount would be equal to 12.00. type: number quantity: description: Quantity of this lineItem. type: number default: 1 image: description: An image of the line item. Valid URLs are accepted only. type: string category: type: string enum: - '5045' - '5065' - '5094' - '5192' - '5193' - '5499' - '5655' - '5691' - '5712' - '5722' - '5812' - '5814' - '5912' - '5977' - '5999' - '7629' EAN: type: string required: - name - singleNet - singleVat - amount billingAddress: description: The billing address of the customer. type: object properties: firstName: type: string maxLength: 200 lastName: type: string maxLength: 200 line1: type: string minLength: 1 maxLength: 200 pattern: ^[\p{L}\p{N}\s\-.,'#/&()°ªº№:;]+$ line2: type: string region: type: string maxLength: 80 pattern: ^[\p{L}\p{N}\s.'\-(),/&]*$ city: type: string minLength: 1 maxLength: 150 pattern: ^[\p{L}\p{M}\p{N}\s\-'.(),&°ªº№:;]+$ zipCode: type: string minLength: 1 maxLength: 30 pattern: ^[\p{L}\p{N}\s\-./]+$ country: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK required: - line1 - city - zipCode - country prefill: description: The values specified here will be pre-filled in the Ivy Checkout. type: object properties: bankId: description: >- Retrieve a valid bankId with the POST /banks/search endpoint. When presented in this field, the customer will skip the bank selection in the Ivy Checkout. type: string pattern: ^[a-z]{2}-[a-z0-9+/-]{1,}$ created: description: >- The Epoch time in seconds at which the Checkout Session was created. By default, time of api CheckoutSession creation at Ivy. type: number minimum: 0 exclusiveMinimum: false expiresAt: description: >- The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 5 minutes to 6 days after Checkout Session creation. By default, this value is 1 hour from creation. type: number locale: type: string enum: - de - nl - en - fr - es - fi - it - pt - sv - pl - sk - lt disableBankSelection: description: >- Disable bank selection mode. If set to true, customers cannot modify the pre selected bank. type: boolean default: false successCallbackUrl: description: >- Users will be redirected here on default after a successful checkout. type: string errorCallbackUrl: description: >- Users will be redirected here on default after an unsuccessful checkout. type: string quoteCallbackUrl: description: Quote Callback requests will be sent to this URL on default. type: string completeCallbackUrl: description: Complete Callback requests will be sent to this URL on default. type: string market: description: >- The market of the checkoutSession. Will show the market banks connected with this market type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK subaccountId: type: string paymentSchemeSelection: type: string enum: - instant_preferred - standard - instant_only x-enumNames: - InstantPreferred - Standard - InstantOnly customer: type: object properties: id: type: string format: uuid email: type: string format: email phone: description: >- The phone number of the customer in international format (e.g., +491631234567) type: string themeVariant: type: string enum: - light - dark required: - referenceId - price ExternalCheckoutSessionResponseDto: type: object properties: id: type: string market: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK availableMarkets: type: array items: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK express: type: boolean paymentMode: type: string enum: - direct - settlement x-enumNames: - Direct - Settlement handshake: type: boolean guest: type: boolean disableBankSelection: type: boolean price: type: object properties: total: type: number minimum: 0.01 exclusiveMinimum: false currency: type: string enum: - EUR - USD - GBP - PLN - SEK - DKK x-enumNames: - EUR - USD - GBP - PLN - SEK - DKK subTotal: type: number shipping: type: number totalNet: type: number vat: type: number required: - total - currency appId: type: string merchantAppId: type: string merchant: type: object properties: id: type: string appId: type: string address: type: object properties: firstName: type: string lastName: type: string line1: type: string minLength: 1 line2: type: string region: type: string city: type: string minLength: 1 zipCode: type: string minLength: 1 country: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK required: - line1 - city - zipCode - country legalName: type: string required: - id - appId - legalName lineItems: type: array items: type: object properties: name: description: Customer-facing name of the line item. type: string referenceId: description: An internal unique id stored to this line item. type: string singleNet: type: number singleVat: type: number amount: description: >- Accumulated cost in decimals. For example, for a lineItem with total price 3.00 and quantity 4, amount would be equal to 12.00. type: number quantity: description: Quantity of this lineItem. type: number default: 1 image: description: An image of the line item. Valid URLs are accepted only. type: string category: type: string enum: - '5045' - '5065' - '5094' - '5192' - '5193' - '5499' - '5655' - '5691' - '5712' - '5722' - '5812' - '5814' - '5912' - '5977' - '5999' - '7629' EAN: type: string co2Grams: type: number minimum: 0 exclusiveMinimum: false required: - name - singleNet - singleVat - amount plugin: type: string prefill: type: object properties: bankId: type: string pattern: ^[a-z]{2}-[a-z0-9+/-]{1,}$ required: - bankId locale: type: string enum: - de - nl - en - fr - es - fi - it - pt - sv - pl - sk - lt required: type: object properties: phone: type: boolean required: - phone offsetProject: type: string expiresAt: type: number created: type: number impactOffsetProjects: type: array items: type: string shopLogo: type: string shopName: type: string customer: type: object properties: id: type: string required: - id incentiveMode: type: string shippingMethods: type: array items: {} selectedShippingMethodId: type: string status: type: string enum: - open - closed - expired x-enumNames: - OPEN - CLOSED - EXPIRED referenceId: type: string displayId: type: string metadata: type: object additionalProperties: {} category: type: string abortReason: type: string billingAddress: type: object properties: firstName: type: string lastName: type: string line1: type: string minLength: 1 line2: type: string region: type: string city: type: string minLength: 1 zipCode: type: string minLength: 1 country: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK required: - line1 - city - zipCode - country shippingAddress: type: object properties: firstName: type: string lastName: type: string line1: type: string minLength: 1 line2: type: string region: type: string city: type: string minLength: 1 zipCode: type: string minLength: 1 country: type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK required: - line1 - city - zipCode - country redirectUrl: type: string successCallbackUrl: type: string errorCallbackUrl: type: string quoteCallbackUrl: type: string completeCallbackUrl: type: string createdAt: {} updatedAt: {} subaccountId: type: string paymentSchemeSelection: type: string enum: - instant_preferred - standard - instant_only x-enumNames: - InstantPreferred - Standard - InstantOnly required: - id - price - appId - merchantAppId - merchant - lineItems - expiresAt - created - status - referenceId - displayId - redirectUrl - successCallbackUrl - errorCallbackUrl securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-Ivy-Api-Key description: API key for authentication ````