Alternative Payment Method (APM) Transaction

This Service is used to for Card / APM processing.

This request type can be used to process supported APMs transactions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

[Length=3] This is the customer code, a unique customer ID allocated to a customer when the service is set up

string
required

[Length=12] This is the site identifier, a unique site ID allocated to a customer when the service is set up

string
required

[Length<=50] This is a username allocated to a service user when the service is set up; it refers to a service account not a person

string
required

This is a combination of how the card was captured and transaction type of the transaction. i.e. mailorder.sale, internet.preAuthorization. Refer to Type under Elements

string
required

This is the monetary value of the transaction in minor units. See Note1

string
required

[Length=3] This is the currency of the transaction. This is the currency code. A three character code in accordance with ISO 4217

string
required

[Length<=50] This is the merchant's own unique reference for the transaction

string

[Length<=50] Required for AliPay/Wechat/Klarna, this is the clientSystemTransactionId from the original transaction

string

[Length<=50] This is the merchant's external facing order number with the consumer, which if supported, will be passed to the Provider as an additional descriptor.

apmDetails
object
details
object
shoppingCartDetails
object
Headers
string
Defaults to Basic QkREVGVzdDpCRERUZXN0
string
Defaults to application/json
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json