API Documentation

Interface

OpenPayPaymentRequest

OpenPayPaymentRequest

The JSON request structure of the Openpay Payments endpoint

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 9

Members

string

# channel

The channel from which this charge is originating, eg. Online, In-Store.

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 38

string

# clientReference

A merchant application specific reference number. This number should uniquely identify the transaction in the merchant’s system.

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 19

string

# customerRef Optional

A merchant application specific reference number. This number should uniquely identify the customer in the merchant’s system.

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 26

string

# merchantTransactedAt Optional

The merchants transaction date and time. The timestamp format is ISO8601.

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 47

string

# orderNumber

The merchant order number of the transaction.

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 34

Array

# payments

List of payments

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 52

OpenPayStoreData

# storeData

OpenPay store data

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 56

string

# tradingAccountId Optional

The unique identifier for the merchants trading account.

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 42

OpenPayPaymentRequestTransactionType

# transactionType

The container transaction type to use for openpay instruments

View Source model/DigiPayModel/OpenPayPaymentRequest.d.ts, line 15