API Documentation

Interface

NewPaymentRequest

NewPaymentRequest

The details of the payment to be created.

View Source model/NewPaymentRequest.d.ts, line 8

Members

Basket

# basket Optional

The Basket associated to the transaction.

View Source model/NewPaymentRequest.d.ts, line 69

boolean

# generateQR Optional

Whether a QRCode should be created and returned in the response

View Source model/NewPaymentRequest.d.ts, line 22

number

# grossAmount

The gross amount to be paid. Must be positive

View Source model/NewPaymentRequest.d.ts, line 18

number

# maxUses Optional

The number of times that the payment request can be used to create a payment. If absent, the API will default value to 1. If set to 0 then the request can be used an unlimited number of times.

View Source model/NewPaymentRequest.d.ts, line 27

MerchantPayload

# merchantPayload Optional

Optional extra details from the merchant.

View Source model/NewPaymentRequest.d.ts, line 79

string

# merchantReferenceId

The unique reference for the payment

View Source model/NewPaymentRequest.d.ts, line 14

PosPayload

# posPayload Optional

Optional extra details from the POS.

View Source model/NewPaymentRequest.d.ts, line 74

string

# specificWalletId Optional

The ID of a specific wallet for which the payment is intended. Can be used in scenarios where a customer has previously requested that their wallet ID is retained for repeat purchase. If supplied the payment can only be used by the intended wallet. If absent then any wallet can create a payment against the Payment Request

View Source model/NewPaymentRequest.d.ts, line 57

number

# timeToLivePayment Optional

The time in seconds that the payment request should remain valid. After this time any use of the request to create a payment will fail. If absent, the API will default value to 0 which indicates that the payment request will not expire until it is deleted

View Source model/NewPaymentRequest.d.ts, line 37

number

# timeToLiveQR Optional

The time in seconds that the QR code should remain valid. After this time any use of the request to create a payment will fail. If absent, the API will default value to 0 which indicates that the code will not expire until it is deleted

View Source model/NewPaymentRequest.d.ts, line 47