Initiate Payment

Hands a payment to the paired terminal. On Newland terminals this does not guarantee that the payment shows up on the terminal: an offline or busy terminal may never fetch it. The response is the state after a hand-off window of at most 7 seconds; a payment the terminal has not picked up by then is cancelled (TERMINATED). Poll Get Payment until the status is final. API version 1.19 and later; up to version 1.18 the wait is 10 status checks, so it grows with the terminal provider's response time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string
required

Your Payrexx instance name

Body Params
integer
required

in cents

string
required
string

Optional free-text descriptor for the transaction. API version 1.18 and later; up to version 1.17 this field is called transactionDescriptor.

string

Optional. Restricts the transaction to a specific payment method. NexGo: e.g. twint, passed on to the terminal. Newland (API version 1.19 and later): CARD, or a payment method from the terminal's paymentMethods (see GET /ecr/{serialNumber}/config). A card brand runs as a card payment; a method the terminal does not offer returns 400. If omitted, a terminal whose paymentMethods include twint asks on screen whether to pay by card or TWINT; otherwise it runs a card payment. TWINT on Newland terminals is coming soon: until it is available, twint returns 400 and an omitted paymentMethod runs a card payment. Up to version 1.18 the field is ignored on Newland terminals.

string

Optional reference ID for the transaction. API version 1.18 and later; up to version 1.17 this field is called paymentReference.

boolean
integer

In cents, added to the total.

shopItems
array of objects
shopItems
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json