Get APM iframe

Returns an iframe that will allow a user to redirect to the chosen alternative payment method's web page in a new window.

The alternative payment method must be chosen upon retrieval of a One-time-use token.

📘

Note

This iframe will emit events, alerting you when the transaction has been submitted, processed, etc.

⚠️

Try It

To use the Try It feature for this endpoint, you must first request an APM one-time-use token.

Request parameters

  • token

Response parameters

  • id
  • merchantId
  • transactionDate
  • transactionStatus
  • amount
  • transactionType
  • currency
  • gatewayResponse
  • gatewayResponse.gatewayName
  • gatewayResponse.refNumber
  • data
  • data.amount
  • data.currency
  • data.settlementCurrency
  • data.customer
  • data.customer.customerRef
  • data.customer.orderNumber
  • data.customer.orderDate
  • data.customer.invoice
  • data.customer.firstName
  • data.customer.lastName
  • data.customer.birthDate
  • data.customer.billToAddressOne
  • data.customer.billToAddressTwo
  • data.customer.billToCity
  • data.customer.billToCountry
  • data.customer.billToPhone
  • data.customer.billToPostal
  • data.customer.billToState
  • data.customer.email
  • data.customer.phone
  • data.customer.shipToAddressOne
  • data.customer.shipToAddressTwo
  • data.customer.shipToCity
  • data.customer.shipToCountry
  • data.customer.shipToPhone
  • data.customer.shipToPostal
  • data.customer.shipToState
  • data.customer.createdAt
  • data.cart
  • data.cart.items
  • data.cart.items.item
  • data.cart.items.description
  • data.cart.items.quantity
  • data.cart.items.price
  • data.cart.items.type
  • data.customFields
  • data.customFields.exampleKey
  • data.description
  • data.descriptor
  • data.descriptor.name
  • data.descriptor.address
  • data.descriptor.city
  • data.descriptor.state
  • data.descriptor.postal
  • data.descriptor.country
  • data.descriptor.phone
  • data.descriptor.url
  • data.descriptor.merchantId
  • data.descriptor.mcc
  • authCode
  • card
  • card.cardNumber
  • card.cardType
  • kountResponse
  • kountResponse.status
  • kountResponse.rules
  • apm
  • apm.token
  • store
  • store.dueDate
  • store.barcodeNumber
  • store.barcodeUrl
Language
Authentication
Query
Click Try It! to start a request and see the response here!