PhysicalSaleTransactionData | ePay documentation

Physical sale data used to create the terminal transaction.

pointOfSaleIdstring

DeprecatedNullable

DEPRECATED - Use terminal.id instead

The ID of the Softpay point of sale to associate the physical sale with.

Format:

uuid

Example:

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

typestring

Nullable

The transaction type to process. Use PAYMENT for purchases and PAYOUT for refunds. Defaults to PAYMENT if not given.

Note that PAYOUT requires the feature to be enabled by SoftPay.

Default:

"PAYMENT"

Possible values:

"PAYMENT""PAYOUT"

Example:

"PAYMENT"

amountinteger

Required

The amount must be defined in minor units. E.g. 2,50 DKK must be set as 250.

Example:

1000

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"

notificationUrlstring

Required

The URL to receive the webhook with the final transaction result.

Format:

uri

Length:

length <= 1024

Example:

"https://example.com/notification"

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.

Match:

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

Length:

1 <= length <= 36

Example:

"store-sale-1"

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.

Example:

"User159"

Customer info associated with the sale. It is recommended to send all the info that is available.

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"

PhysicalSaleTransactionData

{  "pointOfSaleId": "01924737-9c18-71c0-ab1a-88698eaceabf",  "type": "PAYMENT",  "amount": 1000,  "currency": "DKK",  "notificationUrl": "https://example.com/notification",  "reference": "store-sale-1",  "attributes": {    "orderId": "order-123",    "cashRegisterId": "register-7"  },  "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"    },    "billingAddress": {      "countryCode": "DK",      "postalCode": "1400",      "city": "København",      "line1": "Torvegade 45"    }  }}