CreatePhysicalSaleRequest | ePay documentation

nullnever

Physical sale data used to create the terminal transaction.

pointOfSaleIdstring

Required

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.

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.

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.

Example:

{
  "orderId": "order-123",
  "cashRegisterId": "register-7"
}

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.

CreatePhysicalSaleRequest

{  "terminal": {    "id": "0197c07b-3f6d-7be2-b848-702b08958128",    "suppressAppNotifications": false,    "switchBackTimeout": 0,    "activityToResume": null,    "surcharge": false,    "dcc": false  },  "transaction": {    "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"      }    }  }}