# GET /options

## GET /options

> Get APM options

```json
{"openapi":"3.0.0","info":{"title":"Merchant API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"BnplOption":{"type":"object","properties":{"terms":{"type":"string","description":"A human-readable description of the payment terms for this option. Display this text to help customers understand the payment structure if the provider is a BNPL."},"name":{"type":"string","description":"The unique identifier for the APM provider. This is the provider name that should be used in the bnplProvider field when creating an order.","enum":["KLARNA","KLARNA_US","KLARNA_AU","KLARNA_NZ","KLARNA_3_INSTALMENTS","CLEARPAY","AFTERPAY_AU","OPENPAY_AU","ZIP_UK","ZIP_NZ","ZIP_AU","ZIP_SG","OPENPAY_UK","LAYBUY_NZ","LAYBUY_UK","LAYBUY_AU","PAYFLEX_SA","SPLITIT","HOOLAH_SG","HOOLAH_MY","HOOLAH_HK","QUADPAY_US","QUADPAY_CA","OPENPAY_NZ","AFTERPAY_NZ","AFTERPAY_US","AFTERPAY_CA","SEZZLE","AFFIRM_US","AFFIRM_CAD","LATITUDEPAY_AU","SPOTII","PAGANTIS_EU","ALMA","SCALAPAY","TENDOPAY","ATOME","ATOME_TW","ATOME_TH","ATOME_ID","ATOME_MY","ATOME_HK","ATOME_VN","ATOME_PH","RELY_SG","GRAB_SG","GRAB_MY","SOFINCO_X3CB","SOFINCO_X4CB","BILLEASE_PH","HUMM_AU","HUMM_NZ","HUMM_UK","HUMM_IE","PACE","SMARTPAY","PAYPAL","TABBY_AE","TABBY_SA","TABBY_QA","TABBY_KW","TABBY_BH","GENOAPAY","POSTPAY","REAL_SOLUTION_DIRECT_DEBIT","REAL_SOLUTION_OPEN_INVOICE","CLEOPAY","ERATY","ALIPAY_US","ALIPAY_CN","ALIPAY_HK","ALIPAY_PH","ALIPAY_MY","ALIPAY_TH","ALIPAY_ID","ALIPAY_BD","ABLR_MY","ABLR_SG","SHOPBACK_SG","SHOPBACK_MY","BNPP","LATITUDE_IF_AU","LATITUDE_IF_AU_DEFERRED","LATITUDE_IF_AU_DEFFERED","APLAZO_MX","PAYJUSTNOW_SA","TRIPLEA","MPGS","PAYSQUAD_NZ","WAAVE","TAMARA_SA","TAMARA_AE","VALU","PAYTAB","MYFATOORAH_KW","GOCARDLESS","GOCARDLESS_GB","GOCARDLESS_EU","GOCARDLESS_AU","GOCARDLESS_NZ","PAYMOB_EG","CASHEW","MONOOVA_AU","VOLT","LATITUDEPAY_SG","LATITUDEPAY_MY","LINK_US","AZUPAY_AU","AIRWALLEX_AU","ZIP_CA","PLANPAY_AU","RAZORPAY_IN","VOLT_AU","SANDBOX_PAYMENT_METHOD","SANDBOX_PAYMENT_METHOD_V2","IRIS_A2A_EUR","ADYEN_PAYPO_PL","UATP","COINSPAID","COINSPAID_EU","COINSPAID_GB","RAZORPAY_UPI_IN","MYFATOORAH_SA","PAYSAFE_SKRILL_EU","PAYSAFE_NETELLER_EU","PAYSAFECARD_EU","VOLT_BR","TRUSTLY_EU","TRUSTLY_NL","UNIONPAY_CN","KOMOJU","PAYPAY_JPY","PAYEASY_JP","KONBINI_JP","AUPAY_JP","BITCASH_JP","MERPAY_JP","NET_CASH_JP","KOMOJU_BANK_TRANSFER_JP","KOMOJU_CREDIT_CARD_JP","PAIDY_JP","RAKUTENPAY_JP","WEBMONEY_JP","ALIPAY_JP","MYBANK_EU","WECHATPAY_JP","KAKAOPAY_KR","TOUCH_N_GO_MY","GCASH_PHP","DANA_JP","GRABPAY_SG","TOSS_KR","DRAGONPAY_PH","PRZELEWY24_PL","PAYCO_KR","OVO_ID","PAYSAFE_CARD_EUR","LINEPAY_JP","KOREA_CREDIT_CARDS_KR","EPS_EU","PIX_BR","MULTIBANCO_EU","FPX_MY","HAPPY_MONEY_KR","DOKU_ID","CULTURE_VOUCHER_KR","BRAZIL_CREDIT_CARDS_BR","BANCONTACT_BE","BLIK_PL","FISERV_CARDS_AU","FAT_ZEBRA_AU","CREDITEA_MX","RIVERTY_INVOICE_DE","RIVERTY_INVOICE_NL","RIVERTY_PAYIN3_NL","RIVERTY_FIXED_INSTALLMENTS_DE","DLOCAL_SN","DLOCAL_CI","DLOCAL_OPAY_NG","DLOCAL_PAGA_WALLET_NG","FAT_ZEBRA_AU_3DS","KLARNA_MX","KLARNA_CA","KLARNA_HU","KLARNA_RO","KLARNA_PL","KLARNA_CZ","CONTACT_EG","SOUHOOLA_EG","ZIP_US","AFFIRM_GB","SHOPEEPAY","SHOPEEPAY_SG","SPLITITV3","VISA_CYBERSOURCE_CARD","ALIPAY_PLUS","ALIPAY_PLUS_TOUCH_N_GO_MY","PAYU_IN","HELLO_CLEVER_AU","ALIPAY_PLUS_CN","ONEY_4X_FR","ALIPAY_PLUS_GCASH_PH","PAYJUSTNOW_ZA_V2","ALIPAY_PLUS_TRUEMONEY_TH","ALIPAY_PLUS_DANA_JP","HUMM_CA","ALIPAY_PLUS_KAKAOPAY_KR","ALIPAY_PLUS_TOSS_KR","ALIPAY_PLUS_BOOST_MY","ALIPAY_PLUS_NAVERPAY_KR","ALIPAY_PLUS_AKULAKU_ID","ALIPAY_PLUS_RABBIT_LINE_PAY_TH","ALIPAY_PLUS_AKULAKU_PH","ALIPAY_PLUS_BILLEASE_PH","ALIPAY_PLUS_BPI_PH","ALIPAY_PLUS_KREDIVO_ID","ALIPAY_PLUS_MPAY_CN","ALIPAY_PLUS_MPAY_MO","WORLDPAY_CARDS","NUAPAY_GB","NUAPAY_EU","KNET_MYFATOORAH_KW","PAYBY_AE","STRIPE_CARDS","STRIPE","NUVEI_CARDS_AU","ANTOM_GCASH_PH","GOCARDLESS_US","ANTOM","PAYSQUAD","LATITUDE_IF_NZ","VISA_CYBERSOURCE_CARD_AU","ANTOM_PAY_NOW_SG","ANTOM_FAMI_PAY_JP","ANTOM_ALIPAY_HK","ANTOM_IDEAL_EU","ANTOM_BOOST_MY","ANTOM_PROMPT_PAY","ANTOM_KPLUS_TH","ANTOM_MAYA_PH","ANTOM_MERCADO_PAGO","ANTOM_MOMO","VIPPS_MOBILEPAY_NO","ANTOM_PIX","ANTOM_KAKAO_PAY","DLOCAL_KE","DLOCAL_BOOST_MY","DLOCAL_OVO_ID","DLOCAL_TOUCH_N_GO_MY","DLOCAL_FPX_MY","DLOCAL_DUITNOWQR_MY","DLOCAL_GRABPAY_PH","ANTOM_ALIPAY_CN","VIPPS_MOBILEPAY_DK","FLOOSS_BH","VIPPS_MOBILEPAY_FI","PAYU_UPI_IN","IRIS_PAY_GR","DLOCAL_DANA_ID","DLOCAL_SHOPEEPAY_ID","DLOCAL_SHOPEEPAY_MY","DLOCAL_LINKAJA_ID","DLOCAL_MAYBANK_MY","DLOCAL_QRIS_ID","DLOCAL_MAYA_PH","DLOCAL_SHOPEEPAY_PH","DLOCAL_ALFA_PK","DLOCAL_JAZZCASH_PK","DLOCAL_WALLETS_IN","DLOCAL_EASYPAISA_PK","DLOCAL_GCASH_PH","DLOCAL_UPI_IN","DLOCAL_NETBANKING_IN","DLOCAL_VALU_EG","DLOCAL_PIX_BR","AIRWALLEX_US","AIRWALLEX_GB","AIRWALLEX_EU","SPRING_GB","SPRING_GOOGLE_PAY_GB"]},"imageUrl":{"type":"string","description":"The URL of the payment provider's logo image. Use this URL to display the provider logo on your checkout page."},"instalment":{"description":"The installment payment structure for this option. Use this information to display the payment schedule to customers if the APM is a BNPL.","allOf":[{"$ref":"#/components/schemas/Instalment"}]},"monthlyCost":{"description":"The monthly cost for this payment option. This represents the amount the customer will pay per month if they choose this payment method.","allOf":[{"$ref":"#/components/schemas/Rate"}]},"termDurationInMonths":{"type":"number","description":"The total duration of the payment term expressed in months. This is calculated from the installment structure and helps customers understand the repayment period."},"weeklyCost":{"description":"The weekly cost for this payment option. This represents the amount the customer will pay per week if they choose this payment method.","allOf":[{"$ref":"#/components/schemas/Rate"}]},"termDurationInWeeks":{"type":"number","description":"The total duration of the payment term expressed in weeks. This is calculated from the installment structure and helps customers understand the repayment period."},"recommended":{"type":"boolean","description":"Set to True for the payment method with the cheapest monthly or weekly repayment."},"maxAmount":{"type":"number","description":"The maximum cart amount the merchant has selected this provider to be enabled for.","minimum":0},"minAmount":{"type":"number","description":"The minimum cart amount the merchant has selected this provider to be enabled for.","minimum":0},"priority":{"type":"number","description":"The display priority of this payment option on the checkout page. Lower numbers indicate higher priority (priority 1 is the top of the list). Use this value to order payment methods on your checkout page, guiding customers toward preferred payment options. The priority is configured in the Universal Payment Platform (UPP)."},"lateFeesAllowed":{"type":"boolean","description":"Indicates whether late fees have been configured for this payment provider. This is a configuration flag set in the UPP. It does not affect checkout functionality of the APM."},"customerFeesAllowed":{"type":"boolean","description":"Indicates whether customer fees can be configured for this payment provider. This is a configuration flag set in the Universal Payment Platform (UPP)."},"customerFees":{"type":"string","description":"The customer fees configuration status. Indicates whether customer fees are enabled, disabled, or set to custom. Use this along with customerFeesCustomText to display fee information to customers that they must accept before continue with payment.","enum":["disabled","enabled","custom2","custom"]},"lateFees":{"type":"string","description":"The late fees configuration status. Indicates whether late fees are enabled, disabled, or set to custom. Use this along with lateFeesCustomText to display fee information to customers. This does not affect checkout funcitonality.","enum":["disabled","enabled","custom"]},"lateFeesCustomText":{"type":"string","description":"Custom text configured by the merchant regarding late fees for this payment provider. Display this text to inform customers about potential late payment fees. This text is configured in the Universal Payment Platform UPP by the merchant."},"customerFeesCustomText":{"type":"string","description":"Custom text configured by the merchant regarding processing fees for this payment provider. Display this text to inform customers about any processing fees incured and ensure they have accepted the fee. This text is configured in the UPP."},"customerFeesFlat":{"type":"number","description":"The flat rate customer fee amount charged to customers for using this payment method. This is a fixed fee amount regardless of order value."},"customerFeesPercentage":{"type":"number","description":"The percentage rate for customer fees charged to customers for using this payment method. This is calculated as a percentage of the order amount."},"surchargeCap":{"type":"number","description":"The maximum cap on the surcharge amount that can be charged to customers. If the calculated surcharge exceeds this cap, the surcharge will be limited to this amount."},"providerFees":{"type":"number","description":"The flat rate provider fee charged by the payment provider. This is a fixed fee amount that the merchant pays to the provider."},"providerFeesPercentage":{"type":"number","description":"The percentage rate for provider fees charged by the payment provider. This is calculated as a percentage of the order amount that the merchant pays to the provider. This is entered on the UPP by the merchant."},"interestRateAllowed":{"type":"boolean","description":"Indicates whether interest rates can be configured for this payment provider. This is a configuration flag set in the Universal Payment Platform (UPP)."},"isActive":{"type":"boolean","description":"Indicates whether this payment provider is currently active and available for use. Only active providers should be displayed to customers. Inactive providers have been disabled in the Universal Payment Platform (UPP) by the merchant."},"createdAt":{"type":"string","description":"The ISO 8601 timestamp (UTC) when this payment provider configuration was created in the Universal Payment Platform (UPP)."},"updatedAt":{"type":"string","description":"The ISO 8601 timestamp (UTC) when this payment provider configuration was last updated in the Universal Payment Platform (UPP)."},"userName":{"type":"string","description":"The username of the merchant or administrator who created or last modified this payment provider configuration in the Universal Payment Platform (UPP)."},"providerName":{"type":"string","description":"The display name of the payment provider. This is typically the same as the name field but may include additional formatting or branding."},"currency":{"type":"string","description":"The currency this payment provider is configured for. This must match the currency passed in the Get Options request.","enum":["AUD","GBP","USD","NZD","ZAR","EUR","SEK","NOK","DKK","CHF","SGD","CAD","AED","SAR","BHD","OMR","HKD","MYR","PHP","IDR","THB","TWD","VND","TRY","JPY","ILS","HUF","CNY","BRL","MXN","PLN","RUB","CZK","CLP","KWD","BDT","BND","EGP","INR","KRW","LKR","MUR","QAR","NGN","COP","GHS","KES","PEN","TZS","ZMW","BIF","SZL","BSD","GNF","LTL","CDF","CLF","ETB","MOP","ZMK","RSD","KGS","XPF","AZN","XCD","AFN","ERN","BGN","LYD","NPR","CRC","PKR","XOF","TND","MZN","GYD","MGA","KYD","GGP","GIP","MVR","RON","RWF","NAD","JOD","VUV","BBD","UAH","SOS","GEL","BOB","MDL","MMK","LRD","MRO","BYR","PGK","PYG","BZD","SRD","DZD","SVC","ARS","KHR","FJD","UZS","DJF","HNL","LBP","TJS","JEP","FKP","TMT","LSL","ISK","YER","SBD","PAB","BAM","KMF","HTG","ALL","MWK","MAD","GMD","AMD","UGX","DOP","MKD","ZWL","BYN","XAF","STD","NIO","KZT","IQD","WST","ANG","AWG","BTN","ECS","IRR","IEP","ITL","KPW","SLL","STN","SDP","SYP","VEB","VEF","ZWD","AOA","BMD","BWP","CVE","JMD","GTQ","LAK","MNT","SCR","SHP","SLE","TOP","TTD","UYU"]},"checkoutConfig":{"description":"Checkout configuration settings for this payment provider. Contains customizable content, button styling, and terms & conditions configuration that can be displayed during checkout. This configuration is set up in the Universal Payment Platform (UPP) and allows merchants to customize the checkout experience for each payment method.","allOf":[{"$ref":"#/components/schemas/BnplCheckoutBtnConfig"}]},"productDetailsConfig":{"description":"Product details configuration for this payment provider. Contains HTML content that can be displayed on product pages to provide information about the payment method. This content is configured in the Universal Payment Platform (UPP).","allOf":[{"$ref":"#/components/schemas/BnplProductDetailsConfig"}]},"paymentType":{"type":"string","description":"The type or category of the payment provider (e.g., \"BNPL\", \"card\", \"digital wallet\")."},"preferredDisplayMode":{"type":"string","description":"The preferred display mode configured by the merchant for this payment provider. Indicates how the payment interface should be displayed (e.g., \"REDIRECT\" for redirect-based flows, \"IN_CONTEXT\" for embedded flows). This will determine the payment flow type if an order is initiated with our widgets."},"incontextDisplayMode":{"type":"string","description":"The in-context display mode supported by this payment provider. Indicates how the provider's payment interface will be displayed within the merchant's checkout flow when using IN_CONTEXT mode with our widgets (e.g., \"IFRAME\" for embedded iframe, \"POPUP\" for popup overlay). "},"paymentStatusFetchEnabled":{"type":"boolean","description":"Indicates whether payment status will be automatically fetched after processing of order using our widgets. When enabled, our widgets will poll for payment status updates after completion to return on the callback function."},"popupOverlayConfig":{"description":"Configuration for popup overlay content","allOf":[{"$ref":"#/components/schemas/PopupOverlayConfigDto"}]},"requiredFields":{"description":"Information about which customer information fields are required for initiating payment with this provider. Use this to dynamically update your form validation based on the selected payment method. This prevents validation errors and streamlines the customer experience by only requiring fields that are actually needed.","allOf":[{"$ref":"#/components/schemas/RequiredFields"}]},"customProviderLogo":{"type":"string","description":"Custom Logo for Provider"}},"required":["terms","name","imageUrl","instalment","monthlyCost","termDurationInMonths","weeklyCost","termDurationInWeeks","recommended","maxAmount","minAmount","priority","lateFeesAllowed","customerFeesAllowed","customerFees","lateFees","lateFeesCustomText","customerFeesCustomText","customerFeesFlat","customerFeesPercentage","surchargeCap","providerFees","providerFeesPercentage","interestRateAllowed","isActive","createdAt","updatedAt","userName","providerName","currency","checkoutConfig","productDetailsConfig","paymentType","preferredDisplayMode","incontextDisplayMode","paymentStatusFetchEnabled","requiredFields","customProviderLogo"]},"Instalment":{"type":"object","properties":{"rate":{"description":"The payment rate for each installment. Contains the amount and currency for a single installment payment.","allOf":[{"$ref":"#/components/schemas/Rate"}]},"termDuration":{"type":"number","description":"The duration of the payment term. This number, combined with termUnit, specifies how long the payment plan lasts.","minimum":0},"termUnit":{"type":"string","description":"The unit in which the term duration is measured. Common values are \"weeks\" or \"months\". This determines the frequency of installment payments.","enum":["weeks","months"]}},"required":["rate","termDuration","termUnit"]},"Rate":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary amount for this rate. Must be a positive number with up to 2 decimal places. This represents the payment amount per installment, per week, or per month depending on the context.","minimum":0},"currency":{"type":"string","description":"The currency code in ISO 4217 format (three-letter currency code, e.g., AUD, USD, GBP). This must match the currency used in the order."}},"required":["amount","currency"]},"BnplCheckoutBtnConfig":{"type":"object","properties":{"content":{"type":"string","description":"HTML content for BNPL provider during checkout"},"iframeUrl":{"type":"string","description":"Iframe URL"},"button":{"description":"Checkout button configuration","allOf":[{"$ref":"#/components/schemas/CheckoutConfigBtn"}]},"termsCondition":{"description":"Terms and condition configuration","allOf":[{"$ref":"#/components/schemas/CheckoutConfigTC"}]}},"required":["content","iframeUrl","button","termsCondition"]},"CheckoutConfigBtn":{"type":"object","properties":{"type":{"type":"string","description":"Config style to use for button. Global or custom"},"text":{"type":"string","description":"Button text"},"color":{"type":"string","description":"Button text color"},"background":{"type":"string","description":"Button background color"},"position":{"type":"string","description":"Button positioning"},"size":{"type":"string","description":"The button size"}},"required":["type","text","color","background","position","size"]},"CheckoutConfigTC":{"type":"object","properties":{"type":{"type":"string","description":"Type of terms and condition to use"},"content":{"type":"string","description":"Content on terms and condition. Supports HTML & URL"},"linkText":{"type":"string","description":"Terms and condition link text"}},"required":["type","content","linkText"]},"BnplProductDetailsConfig":{"type":"object","properties":{"content":{"type":"string","description":"The APM provider product details"}},"required":["content"]},"PopupOverlayConfigDto":{"type":"object","properties":{"title":{"type":"string","description":"Title displayed in the popup overlay"},"message":{"type":"string","description":"Message displayed in the popup overlay"}},"required":["title","message"]},"RequiredFields":{"type":"object","properties":{"billingAddress":{"description":"Billing address fields required for initiating payment with this provider. This object indicates which billing address fields are mandatory for the selected payment method. Use this information to dynamically update your form validation based on the customer's selected payment method to prevent validation errors and streamline the checkout experience.","allOf":[{"$ref":"#/components/schemas/BnplBillingAddressConfigDto"}]}},"required":["billingAddress"]},"BnplBillingAddressConfigDto":{"type":"object","properties":{"email":{"type":"boolean","description":"Indicates whether the email field is required for this payment provider. Set to true if the provider requires email address for payment processing."},"phoneNumber":{"type":"boolean","description":"Indicates whether the phoneNumber field is required for this payment provider. Set to true if the provider requires phone number for payment processing or verification."},"region":{"type":"boolean","description":"Indicates whether the region field is required for this payment provider. Set to true if the provider requires region/administrative area for address verification."},"state":{"type":"boolean","description":"Indicates whether the state field is required for this payment provider. Set to true if the provider requires state/province for address verification (common for countries like US, Canada, Australia)."},"postalCode":{"type":"boolean","description":"Indicates whether the postalCode field is required for this payment provider. Set to true if the provider requires postal/ZIP code for address verification."},"city":{"type":"boolean","description":"Indicates whether the city field is required for this payment provider. Set to true if the provider requires city for address verification."},"country":{"type":"boolean","description":"Indicates whether the country field is required for this payment provider. Set to true if the provider requires country code for payment processing."},"streetAddress":{"type":"boolean","description":"Indicates whether the streetAddress field (address line 1) is required for this payment provider. Set to true if the provider requires street address for address verification."},"streetAddress2":{"type":"boolean","description":"Indicates whether the streetAddress2 field (address line 2) is required for this payment provider. Set to true if the provider requires additional address details."}},"required":["email","phoneNumber","region","state","postalCode","city","country","streetAddress","streetAddress2"]}}},"paths":{"/options":{"get":{"operationId":"OptionsController_getOptions","summary":"Get APM options","parameters":[{"name":"amount","required":true,"in":"query","description":"The current cart or order amount for which to retrieve available payment providers. This amount is used to filter payment methods based on their minimum and maximum amount limits. Must be a positive number greater than or equal to 1.","schema":{"minimum":1,"type":"number"}},{"name":"currency","required":true,"in":"query","description":"The currency for the order in ISO 4217 format (three-letter currency code, e.g., AUD, USD, GBP). This determines which payment providers are available, as providers are configured for specific currencies. The currency must match the currency you will use when creating the order.","schema":{"type":"string"}},{"name":"channel","required":false,"in":"query","description":"The channel alias identifier to filter payment methods by channel configuration. If provided, only payment methods enabled for this channel will be returned. If not provided, all payment methods configured without a channel (default channel) will be returned. The same channel should be passed to both the Options endpoint and the Create Order endpoint to ensure consistency. Channels allow you to configure different payment methods and credentials for different sales channels (e.g., e-commerce, mobile app, in-store).","schema":{"type":"string"}},{"name":"isCapable","required":true,"in":"query","description":"Flag to include base64-encoded image data in the response. When set to true, the response will include the image field with base64-encoded logo data for each payment provider. When false (default), only the imageUrl field is returned. Set to true if you need to display provider logos without making additional HTTP requests.","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"Returns a list of APM options","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BnplOption"}}}}}},"tags":["options"]}}}}
```