Main docs page Auth API Ordering API Menu API Venue API Inventory API

Ordering API - Payment Service (1)

Download OpenAPI specification:Download

Payment Service for Ordering Stack

Authentication

BearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Payment Service

CreatePayment

This method allows you to prepare transaction for a customer. The method returns transaction title required for other API methods and redirection link for a customerIf errors send proper response. If CreatePayment succeded return "200 OK" response.

Authorizations:
Request Body schema: application/json
orderId
string
paymentType
integer
amount
integer
returnUrl
string
returnErrorUrl
string

Responses

Request samples

Content type
application/json
{
  • "orderId": "string",
  • "paymentType": 0,
  • "amount": 0,
  • "returnUrl": "string",
  • "returnErrorUrl": "string"
}

Response samples

Content type
application/json
Example
{
  • "trxId": "string",
  • "url": "string",
  • "shouldRedirect": true
}

CreatePaymentBlik

This method allows sending a BLIK code in direct communication between merchant and BLIK system. In ‘create’ method you should set 150 as a value for parameter ‘group’, this is a BLIK payment channel. If CreatePayment succeded return "200 OK" response with boolean value = true.

Authorizations:
Request Body schema: application/json
trxId
string
blikCode
string

Responses

Request samples

Content type
application/json
{
  • "trxId": "string",
  • "blikCode": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

ConfirmPayment

Can be called only from restricted IP addresses from payment provider. It is mandatory to verify the address to ensure that it comes from the tpay.com online payments server.

Request Body schema: application/json
id
string
tr_id
string
tr_amount
string
tr_paid
string
tr_crc
string
tr_status
string
tr_error
string
tr_date
string <date-time>
tr_desc
string
tr_email
string
md5sum
string
test_mode
string
ip
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "tr_id": "string",
  • "tr_amount": "string",
  • "tr_paid": "string",
  • "tr_crc": "string",
  • "tr_status": "string",
  • "tr_error": "string",
  • "tr_date": "2019-08-24T14:15:22Z",
  • "tr_desc": "string",
  • "tr_email": "string",
  • "md5sum": "string",
  • "test_mode": "1",
  • "ip": "string"
}

PaymentRefund

Requires client token. Unfinished.

Responses

GetPaymentTypes

Find Payment Services allowed by tenant

Authorizations:
query Parameters
venueId
required
string

venueId of the object to fetch data.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]