CreateMotoTransactionRequest
transaction object
Id of the point of sale to associate the payment with.
01924737-9c18-71c0-ab1a-88698eaceabfThis 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.
Possible values: non-empty and <= 36 characters, Value must match regular expression ^[A-Za-z0-9-]{1,36}$
reference-1The 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.
100The currency code of the payment. For Danish Kroner defined as DKK. ISO 4217 alpha-3 (e.g., DKK)
Possible values: Value must match regular expression ^[A-Z]{3}$
DKKIf the payment should be captured instantly or not.
-
OFFindicates that the payment should not be captured instantly. -
VOIDindicates that the payment should be captured instantly and if somehow the instant capture fails the payment is voided. -
NO_VOIDindicates 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]
OFFDEPRECATED: 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.
Possible values: [shift4, clearhaus, nets, worldline]
["shift4"]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.
Possible values: non-empty and <= 39 characters
order 123attributes objectnullable
A list of pass through attributes that is sent back to the merchant on webhooks. Max size is 1kb.
A list of pass through attributes that is sent back to the merchant on webhooks. Max size is 1kb.
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.
User159customer object
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.
The first name of the paying customer.
Possible values: non-empty
PeterThe last name of the paying customer.
Possible values: non-empty
NielsenThe date of birth of the cardholder in YYYY-MM-DD format.
2000-07-25The email of the paying customer.
Possible values: non-empty
email@example.comE.164 phone number format with a single space between country code and local number. No additional spaces allowed.
Format: "+[countryCode] [number]".
Possible values: Value must match regular expression ^\+\d{1,3} \d+$
+45 12345678shippingAddress objectnullable
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.
ISO 3166-1 alpha-2 country code
Possible values: >= 2 characters and <= 2 characters
DKThe local postal code of the address
Possible values: non-empty and <= 16 characters
1400The city
Possible values: non-empty and <= 50 characters
KøbenhavnThe first address line. Most address only has a singular line.
Possible values: non-empty and <= 50 characters
Torvegade 45Second address line. Only use if address contains multiple lines. Always start with line1.
Possible values: non-empty and <= 50 characters
2. th.Third address line. Only use if address contains multiple lines. Always start with line1 and line2.
Possible values: non-empty and <= 50 characters
ChristianshavnbillingAddress objectnullable
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.
ISO 3166-1 alpha-2 country code
Possible values: >= 2 characters and <= 2 characters
DKThe local postal code of the address
Possible values: non-empty and <= 16 characters
1400The city
Possible values: non-empty and <= 50 characters
KøbenhavnThe first address line. Most address only has a singular line.
Possible values: non-empty and <= 50 characters
Torvegade 45Second address line. Only use if address contains multiple lines. Always start with line1.
Possible values: non-empty and <= 50 characters
2. th.Third address line. Only use if address contains multiple lines. Always start with line1 and line2.
Possible values: non-empty and <= 50 characters
ChristianshavnIf not null then pre-authorization webhook are enabled for all transaction attempts for the session. Max length is 1024.
Possible values: non-empty and <= 1024 characters
https://example.com/preAuthorderLines object[]nullable
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.
Possible values: <= 1000
Descriptive name of the order line item.
Possible values: non-empty and <= 255 characters
Running shoeURL 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.
Possible values: non-empty and <= 1024 characters
Quantity of the order line item. Must be a non-negative number.
Possible values: >= 0
2Total amount of the order line. Must be defined as minor units. Includes tax and discount.
Possible values: >= 0 and <= 200000000
20000Price 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.
Possible values: <= 200000000
10000Type of the order line item.
Possible values: [PHYSICAL, DISCOUNT, SHIPPING_FEE, SALES_TAX, DIGITAL, GIFT_CARD, STORE_CREDIT, SURCHARGE, OTHER]
subscription object
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.
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.
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.
The type of subscription.
UNSCHEDULEDPay-as-you-go type subscriptions with no fixed interval for charges.SCHEDULEDFixed interval charges like a subscription paid monthly.
Possible values: [UNSCHEDULED, SCHEDULED]
SCHEDULEDAn optional merchant defined reference for the subscription. If none is given, then the session reference will be used as a fallback.
subscription-1An 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.
interval object
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.
The period unit between charges
Possible values: [DAY, WEEK, MONTH, YEAR]
The number of period units between each charge. 1-31. Example: Frequency: 3, Period: DAY One charge every 3 days.
billingAgreement objectnullable
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
The id of the billing plan to use for the agreement. The billing plan contains the price and interval used during automatic charging.
019a7266-2f3a-7b26-9c93-b950aea9e13cAn optional reference to be added to the created billing agreement. If not set, the one from the subscription will be used.
agreement-1Which 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.
2030-07-22paymentMethod object
card object
The primary account number (PAN) of the card to charge. Must be Luhn compliant.
Possible values: >= 15 characters and <= 19 characters
1234567812345678The month part of the expiry of the card to charge.
Possible values: >= 2 characters and <= 2 characters
07The year part of the expiry of the card to charge.
Possible values: >= 2 characters and <= 2 characters
35The CVV / CVC of the card to charge
Possible values: >= 2 characters and <= 3 characters
123An optional parameter that can be used to choose which brand of a cobranded card to charge. Such as when payment with a VisaDankort card. Otherwise leave blank.
Visa{
"transaction": {
"pointOfSaleId": "01924737-9c18-71c0-ab1a-88698eaceabf",
"reference": "reference-1",
"amount": 100,
"currency": "DKK",
"instantCapture": "OFF",
"textOnStatement": "order 123",
"attributes": {},
"customerId": "User159",
"customer": {
"firstName": "Peter",
"lastName": "Nielsen",
"birthdate": "2000-07-25",
"email": "email@example.com",
"phoneNumber": "+45 12345678",
"shippingAddress": {
"countryCode": "DK",
"postalCode": "1400",
"city": "København",
"line1": "Torvegade 45",
"line2": "2. th.",
"line3": "Christianshavn"
},
"billingAddress": {
"countryCode": "DK",
"postalCode": "1400",
"city": "København",
"line1": "Torvegade 45",
"line2": "2. th.",
"line3": "Christianshavn"
}
},
"preAuthUrl": "https://example.com/preAuth",
"orderLines": [
{
"description": "Running shoe",
"imageUrl": "string",
"quantity": 2,
"totalAmount": 20000,
"unitPrice": 10000,
"type": "PHYSICAL"
}
],
"subscription": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"amount": 0,
"type": "SCHEDULED",
"reference": "subscription-1",
"expiryDate": "2024-07-29",
"interval": {
"period": "DAY",
"frequency": 0
},
"billingAgreement": {
"billingPlanId": "019a7266-2f3a-7b26-9c93-b950aea9e13c",
"reference": "agreement-1",
"nextChargeAt": "2030-07-22"
}
}
},
"paymentMethod": {
"card": {
"cardNumber": 1234567812345678,
"expiryMonth": "07",
"expiryYear": "35",
"securityCode": "123",
"brand": "Visa"
}
}
}