API Reference
HomeWebsite

Create a new order transaction

post
https://sandbox-api.unify-retail.com/v1/orders//transactions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the order

Query Params
string
enum

Order transaction status

Allowed:
string
enum

Order transaction type

Allowed:
include
array of strings

Array of related resources to include in the response

include
Allowed:
Body Params
string
required
length ≤ 100

ID of the order transaction

string
length ≤ 100

ID of the order linked to the transaction

string
enum
required

The type of the transaction

Allowed:
string
length ≤ 50

Gateway used for the transaction

payment_method
object
required

Payment method used for the transaction

string
enum
required

Status of the transaction

Allowed:
double
required

Amount of the transaction

string
length ≤ 200

Comment for the transaction

string
enum

Specifies the context in which the transaction was completed. Possible values are:

  • WEB: Order paid on the website.
  • TPE: Order paid on the store payment terminal (TPE).
  • TAP-TO-PAY: Order paid using the store tap-to-pay device.
  • POS: Order paid via the point-of-sale system (cash register).
Allowed:
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?