GET /options

Get APM options

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
amountnumberRequired

The current cart amount

currencystringRequired

The currency, in ISO 4217 format.

channelstringOptional

The channel being used

isCapablebooleanRequired

The flag to send image data in response.

Responses
200

Returns a list of APM options

application/json
get
/options
GET /options?amount=1&currency=text&isCapable=true HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Returns a list of APM options

[
  {
    "terms": "text",
    "name": "text",
    "imageUrl": "text",
    "instalment": {
      "rate": {
        "amount": 1,
        "currency": "text"
      },
      "termDuration": 1,
      "termUnit": "text"
    },
    "monthlyCost": {
      "amount": 1,
      "currency": "text"
    },
    "termDurationInMonths": 1,
    "weeklyCost": {
      "amount": 1,
      "currency": "text"
    },
    "termDurationInWeeks": 1,
    "recommended": true,
    "ratings": 1,
    "ratingsAvailabilityStatus": true,
    "maxAmount": 1,
    "minAmount": 1,
    "priority": 1,
    "lateFeesAllowed": true,
    "customerFeesAllowed": true,
    "customerFees": "text",
    "lateFees": "text",
    "lateFeesCustomText": "text",
    "customerFeesCustomText": "text",
    "customerFeesFlat": 1,
    "customerFeesPercentage": 1,
    "providerFees": 1,
    "providerFeesPercentage": 1,
    "interestRateAllowed": true,
    "interestRate": 1,
    "isActive": true,
    "createdAt": "text",
    "updatedAt": "text",
    "userName": "text",
    "providerName": "text",
    "currency": "text",
    "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": "text",
    "image": "text",
    "preferredDisplayMode": "text",
    "incontextDisplayMode": "text",
    "paymentStatusFetchEnabled": true,
    "popupOverlayConfig": {
      "title": "Payment in progress",
      "message": "Click anywhere to continue payment!"
    },
    "requiredFields": {
      "billingAddress": {
        "email": true,
        "phoneNumber": true,
        "region": true,
        "state": true,
        "postalCode": true,
        "city": true,
        "country": true,
        "streetAddress": true,
        "streetAddress2": true
      }
    }
  }
]
PreviousOptionsNextPOST /orders