Skip to main content

Request Fields

Initial Request (Hosted and Direct Integration)​

These fields should be sent in addition to the Basic Request Fields excluding any card details.

Field NameMandatory?Description
paymentMethodYes[1]Payment method to be used with PPRO (eg ppro.astropay, ppro.alipay, etc).
checkoutRedirectURLYes[2]URL on Merchant’s server to return to when the PPRO APM Checkout is closed.
checkoutOptionsNo[3],[4]Record containing options used to customise the PPRO APM Checkout. Refer here.
pproCheckoutOptionsNo[5],[4]Record containing options used to customise the PPRO APM Checkout. Refer here.

Checkout Options (Hosted and Direct Integration)​

The following options may be sent in the pproCheckoutOptions Hosted Integration field or the checkoutOptions Direct Integration field to customise the Checkout. The options must be formatted using the record or serialised record formats.

Sub-Field NameDescription
nationalidConsumer’s national ID (up to 30 characters).
consumerrefUnique reference identifying the consumer within 1 to 20 characters and a format of A-Za-z0-9.%,&/+*$-
siteidUnique site identifier. Required for clients serving multiple points of sale and forwarded onwards whilst using the qiwi payment method.
ibanValid IBAN of consumer/destination account.
sequencetype

Sequence type of the direct debit.

Possible values are:

oneOff – The direct debit is executed once (default)

first – First direct debit in a series of recurring ones

mandatereferenceMandate reference as returned on the first transaction in the sequence (found from mandatereference in checkoutDetails)
mandatesignaturedateDate of the initial transaction.
bicValid BIC (8 or 11 alphanumeric letters) – optionally supplied to skip the bank selection page (by using the bank referenced by BIC as supplied)
clientipOptional IP address of the consumer during checkout using Trustly (127.0.0.1 is not allowed!)
addressCustomer’s billing address[6][6]
cityCustomer’s billing city[6][7]
phoneCustomer’s phone[6][6]
mobilephoneCustomers mobile phone[6][7]
dobMCC 6012 Date of Birth[6][6]
dynamicdescriptorStatement narrative[6][7]

Footnotes

  1. Optional in Hosted Integration.
  2. Not required for Hosted Integration.
  3. Direct Integration only.
  4. Whilst the Gateway does not see this field as mandatory, PPRO may have payment methods that require additional configuration using checkout options.
  5. Hosted Integration Only.
  6. This information is supplied to PPRO by default using the following fields: `customerAddress`, `customerPostcode`, `customerTown`, `customerEmail`, `customerPhone`, `customerMobile`, `receiverDateOfBirth`, `statementNarrative1`.
  7. This information is supplied to PPRO by default using the following fields: `customerAddress`, `customerPostcode`, `customerTown`, `customerEmail`, `customerPhone`, `customerMobile`, `receiverDateOfBirth`, `statementNarrative1`.