GET /options

Get APM options

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

amountnumber · min: 1Required

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.

Example: 100

currencystringRequired

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.

Example: AUD

channelstringOptional

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).

Example: mobile-app-v2

isCapablebooleanRequired

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.

Default: falseExample: false

Responses

200

Returns a list of APM options

application/json

get

/options

HTTPcURLJavaScriptPython

GET /options?amount=1&currency=text&isCapable=false HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a list of APM options

[
  {
    "terms": "Pay AUD 25 in 4 installments every 2 weeks with Afterpay AU.",
    "name": "AFTERPAY_AU",
    "imageUrl": "https://widgets.qa.optty.com/images/logos/bnpl_afterpay_1.0.svg",
    "instalment": {
      "rate": {
        "amount": 25,
        "currency": "AUD"
      },
      "termDuration": 8,
      "termUnit": "weeks"
    },
    "monthlyCost": {
      "amount": 50,
      "currency": "AUD"
    },
    "termDurationInMonths": 2,
    "weeklyCost": {
      "amount": 12.5,
      "currency": "AUD"
    },
    "termDurationInWeeks": 8,
    "recommended": true,
    "maxAmount": 2000,
    "minAmount": 0,
    "priority": 1,
    "lateFeesAllowed": false,
    "customerFeesAllowed": false,
    "customerFees": "disabled",
    "lateFees": "disabled",
    "lateFeesCustomText": "",
    "customerFeesCustomText": "Custom Customer fee message",
    "customerFeesFlat": 0,
    "customerFeesPercentage": 0,
    "surchargeCap": 0,
    "providerFees": 0,
    "providerFeesPercentage": 0,
    "interestRateAllowed": false,
    "isActive": true,
    "createdAt": "2024-01-25T23:31:20.091Z",
    "updatedAt": "2024-01-26T10:30:30.133Z",
    "userName": "Merchant",
    "providerName": "AFTERPAY_AU",
    "currency": "AUD",
    "checkoutConfig": {
      "content": "text",
      "iframeUrl": "text",
      "button": {
        "type": "text",
        "text": "text",
        "color": "text",
        "background": "text",
        "position": "text",
        "size": "text"
      },
      "termsCondition": {
        "type": "text",
        "content": "text",
        "linkText": "text"
      }
    },
    "productDetailsConfig": {
      "content": "text"
    },
    "paymentType": "BNPL",
    "preferredDisplayMode": "REDIRECT",
    "incontextDisplayMode": "IFRAME",
    "paymentStatusFetchEnabled": false,
    "popupOverlayConfig": {
      "title": "Payment in progress",
      "message": "Click anywhere to continue payment!"
    },
    "requiredFields": {
      "billingAddress": {
        "email": true,
        "phoneNumber": true,
        "region": false,
        "state": true,
        "postalCode": true,
        "city": true,
        "country": true,
        "streetAddress": true,
        "streetAddress2": false
      }
    },
    "customProviderLogo": "text"
  }
]