MotoTransactionData | ePay documentation

pointOfSaleIdstring

Required

Id of the point of sale to associate the payment with.

Format:

uuid

Example:

"01924737-9c18-71c0-ab1a-88698eaceabf"

referencestring

Nullable

This is the transaction reference, similar to an order ID.
The reference SHOULD be unique for each payment, as some acquirers enforce per-payment uniqueness.
Using a duplicate reference may result in failed payments or make reconciliation difficult.
Only ASCII alphanumeric characters and dashes are allowed.

Worldline specific: - is removed if present and if the value is longer than 12 position, the left most part is used.

Match:

^[A-Za-z0-9-]{1,36}$

Length:

1 <= length <= 36

Example:

"reference-1"

amountinteger

Required

The amount must be defined in minor units. E.g. 2,50 DKK must be set as 250. If amount is set to 0 a token will be created only and returned to the integrator.

Example:

100

currencystring

Required

The currency code of the payment. For Danish Kroner defined as DKK. ISO 4217 alpha-3 (e.g., DKK)

Match:

^[A-Z]{3}$

Example:

"DKK"

instantCapturestring

Nullable

If the payment should be captured instantly or not.

OFF indicates that the payment should not be captured instantly.

VOID indicates that the payment should be captured instantly and if somehow the instant capture fails the payment is voided.

NO_VOID indicates that the payment should be captured instantly and if the capture fails the authorization is kept (no void is made)

Possible values:

"OFF""VOID""NO_VOID"

Example:

"OFF"

DEPRECATED: This parameter will soon be removed and will no longer have any effect. The functionality has been replaced by routing rules in the ePay back office.

List of processors to use. This is the routing of the payment. The value can be shift4, clearhaus and nets.

Processor priority follows the order in the list. If the first processor fails or declines, the next processor in the list will be attempted, and so on until all processors have been tried. Note that the actual processing order is not guaranteed and may depend on external factors, such as the specific payment card used by the cardholder.

textOnStatementstring

Nullable

This is the text set on the transaction in the bank viewed by the card holder. That can be e.g. "order 123". Defaults to the ePay transaction id. Some providers does not support long texts, ePay will automatically cut the text to fit the providers requirements.

Length:

1 <= length <= 39

Example:

"order 123"

A list of pass through attributes that is sent back to the merchant on webhooks. Max size is 1kb.

customerIdstring

Nullable

An optional merchant defined customer id used to uniquely identify a user in the merchant system. This field is required to enable stored payment methods and enhanced age verification.

Example:

"User159"

Customer info. These data points are used during SCA/3DS and is required for some schemes. These data may also be sent to the specific payment provider, if required to complete the payment such as Klarna. It is recommended to send all the info that is available to improve the approval rate.

firstNamestring

Nullable

The first name of the paying customer.

Length:

1 <= length

Example:

"Peter"

lastNamestring

Nullable

The last name of the paying customer.

Length:

1 <= length

Example:

"Nielsen"

birthdatestring

Nullable

The date of birth of the cardholder in YYYY-MM-DD format.

Format:

date

Example:

"2000-07-25"

emailstring

Nullable

The email of the paying customer.

Length:

1 <= length

Example:

"email@example.com"

phoneNumberstring

Nullable

E.164 phone number format with a single space between country code and local number. No additional spaces allowed.

Format: "+[countryCode] [number]".

Match:

^\+\d{1,3} \d+$

Example:

"+45 12345678"

The shipping address of the purchase. If no wares are shipped, leave this empty. If billing and shipping address is the same, then fill both properties with identical information.

countryCodestring

Nullable

ISO 3166-1 alpha-2 country code

Length:

2 <= length <= 2

Example:

"DK"

postalCodestring

Nullable

The local postal code of the address

Length:

1 <= length <= 16

Example:

"1400"

citystring

Nullable

The city

Length:

1 <= length <= 50

Example:

"København"

line1string

Nullable

The first address line. Most address only has a singular line.

Length:

1 <= length <= 50

Example:

"Torvegade 45"

line2string

Nullable

Second address line. Only use if address contains multiple lines. Always start with line1.

Length:

1 <= length <= 50

Example:

"2. th."

line3string

Nullable

Third address line. Only use if address contains multiple lines. Always start with line1 and line2.

Length:

1 <= length <= 50

Example:

"Christianshavn"

The billing address of the customer. Often the personal address of the customer or the business address of paying company. If billing and shipping address is the same, then fill both properties with identical information.

countryCodestring

Nullable

ISO 3166-1 alpha-2 country code

Length:

2 <= length <= 2

Example:

"DK"

postalCodestring

Nullable

The local postal code of the address

Length:

1 <= length <= 16

Example:

"1400"

citystring

Nullable

The city

Length:

1 <= length <= 50

Example:

"København"

line1string

Nullable

The first address line. Most address only has a singular line.

Length:

1 <= length <= 50

Example:

"Torvegade 45"

line2string

Nullable

Second address line. Only use if address contains multiple lines. Always start with line1.

Length:

1 <= length <= 50

Example:

"2. th."

line3string

Nullable

Third address line. Only use if address contains multiple lines. Always start with line1 and line2.

Length:

1 <= length <= 50

Example:

"Christianshavn"

preAuthUrlstring

Nullable

If not null then pre-authorization webhook are enabled for all transaction attempts for the session. Max length is 1024.

Format:

uri

Length:

1 <= length <= 1024

Example:

"https://example.com/preAuth"

The array containing list of line items that are part of this order. Maximum of 1000 line items could be processed in a single order. This is used by some payment methods, such as Klarna.

Items:

items <= 1000

Array [

descriptionstring

Required

Descriptive name of the order line item.

Length:

1 <= length <= 255

Example:

"Running shoe"

imageUrlstring

Nullable

URL to an image that can be later embedded in communications between Klarna and the customer. (max 1024 characters). A minimum of 250x250 px resolution is recommended for the image to look good. We recommend using a good sized image (650x650 px or more), however the file size must not exceed 12MB.

Format:

url

Length:

1 <= length <= 1024

quantityinteger

Required

Quantity of the order line item. Must be a non-negative number.

Range:

0 <= value

Example:

2

totalAmountinteger

Required

Total amount of the order line. Must be defined as minor units. Includes tax and discount.

Range:

0 <= value <= 200000000

Example:

20000

unitPriceinteger

Required

Price for a single unit of the order line. Must be defined as minor units and exclude any discount. Typically including taxes, however some countries may include specific requirements.

Range:

value <= 200000000

Example:

10000

typestring

Required

Type of the order line item.

Possible values:

"PHYSICAL""DISCOUNT""SHIPPING_FEE""SALES_TAX""DIGITAL""GIFT_CARD""STORE_CREDIT""SURCHARGE""OTHER"

]

Note scaMode is always set to FORCE when initializing a subscription due to EU PSD2 regulations.

To create a subscription, allowing you to process MIT transactions in the future, you must send the subscription object. To process MIT transactions you must ensure your acquirer agreement has recurring payments enabled.

idstring

An optional subscription ID can be used to update an existing active subscription with new payment details, such as a new card or a completely different payment method.

Format:

uuid

amountinteger

An optional amount in minor units (e.g., 1095 = 10.95 DKK) that can be used to differentiate the recurring subscription amount from the current transaction amount. This is useful if customers are not expected to pay today, but must pay a monthly fee going forward - In this case set amount=0 and subscription.amount=XXX. Defaults to the transaction amount if not given.

typestring

Required

The type of subscription.

UNSCHEDULED Pay-as-you-go type subscriptions with no fixed interval for charges.

SCHEDULED Fixed interval charges like a subscription paid monthly.

Possible values:

"UNSCHEDULED""SCHEDULED"

Example:

"SCHEDULED"

referencestring

An optional merchant defined reference for the subscription. If none is given, then the session reference will be used as a fallback.

Example:

"subscription-1"

expiryDatestring

An optional field indicating the expiry of the subscription. This date is used during 3DS, and may improve conversion rates. ePay does not reject payments after this date.

Format:

date

An optional subscription schedule for SCHEDULED type subscriptions. Must be omitted for UNSCHEDULED type subscriptions. Is required by some payment methods such as Vipps Mobilepay. Is used during 3DS - May improve conversion rates.

An optional property. When given a automatic scheduled billing agreement will be created. This can be used to sign up customers to automatic subscription billing, such as monthly payments. This field is mutually exclusive with subscription.id and subscription.interval

billingPlanIdstring

Required

The id of the billing plan to use for the agreement. The billing plan contains the price and interval used during automatic charging.

Format:

uuid

Example:

"019a7266-2f3a-7b26-9c93-b950aea9e13c"

referencestring

Nullable

An optional reference to be added to the created billing agreement. If not set, the one from the subscription will be used.

Example:

"agreement-1"

nextChargeAtstring

Nullable

Which date to create the first automatic charge. If left blank the current date plus the plan interval will be used to calculate the next charge. This can be used for introductory campaigns where the first period is free followed by monthly charges.

Format:

date

Example:

"2030-07-22"

MotoTransactionData

{  "pointOfSaleId": "01924737-9c18-71c0-ab1a-88698eaceabf",  "reference": "reference-1",  "amount": 100,  "currency": "DKK",  "instantCapture": "OFF",  "processor": [    "shift4"  ],  "textOnStatement": "order 123",  "attributes": {    "property1": null,    "property2": null  },  "customerId": "User159",  "customer": {    "firstName": "Peter",    "lastName": "Nielsen",    "email": "email@example.com"  },  "preAuthUrl": "https://example.com/preAuth",  "orderLines": [    {      "description": "Running shoe",      "imageUrl": "string",      "quantity": 2,      "totalAmount": 20000,      "unitPrice": 10000,      "type": "PHYSICAL"    }  ],  "subscription": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "amount": 0,    "type": "SCHEDULED",    "reference": "subscription-1",    "expiryDate": "2019-08-24",    "interval": {      "period": "DAY",      "frequency": 0    },    "billingAgreement": {      "billingPlanId": "019a7266-2f3a-7b26-9c93-b950aea9e13c",      "reference": "agreement-1",      "nextChargeAt": "2030-07-22"    }  }}