Skip to main content
Versionv1.9.0
API docs by Redocly

Merchant API (1.9.0)

Download OpenAPI specification:Download

Development: [email protected] URL: https://www.payplaza.com

Payment Acceptance Made Easy

The MerchantAPI allows merchants to interact with and retrieve information from the PayPlaza payment system. It allows merchants to retrieve information about how their account has been setup with Stores and Terminals. It allows merchants to retrieve the list and the details of Transactions and it allows merchants to initiate a new Payment.

Errors

Error responses, HTTP status 400 and higher, will contain a JSON response body with details about the error. We follow the error response format proposed in RFC 7807 also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response.

Note: Problem type and instance identifiers in our APIs are not meant to be resolved. RFC 7807 encourages that problem types are URI references that point to human-readable documentation, but we deliberately decided against that, as all important parts of the API are documented.

Security

For managing API keys

Retrieve details about the available APIKeys

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new API key

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
label
required
string
object or null

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "validity": {
    }
}

Response samples

Content type
application/json
{
  • "id": "stringstringstr",
  • "label": "string",
  • "apikey": "stringstringstringstringstringstringstringstringst"
}

Delete an API key

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Responses

Stores

Operations related to stores

List all stores.

Authorizations:
ApiKeyAuth
query Parameters
page
integer <int32> >= 1
Default: 1

The page number of your query result

size
integer <int32> [ 1 .. 100 ]
Default: 10

The amount of results (defaults to 10)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Terminals

Operations related to terminals

List all terminals.

Authorizations:
ApiKeyAuth
query Parameters
page
integer <int32> >= 1
Default: 1

The page number of your query result, starting at 1

size
integer <int32> [ 1 .. 100 ]
Default: 10

The amount of results per page, maximum 100 (defaults to 10)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get terminal by manufacturer, model & serial.

Authorizations:
ApiKeyAuth
path Parameters
manufacturer
required
string [ 1 .. 255 ] characters

Manufacturer name of the terminal

model
required
string [ 1 .. 255 ] characters

Model name of the terminal

serial
required
string [ 1 .. 255 ] characters

Serial(number) of the terminal

Responses

Response samples

Content type
application/json
{
  • "device": {
    }
}

Get the day totals for the terminal by manufacturer, model & serial.

Authorizations:
ApiKeyAuth
path Parameters
manufacturer
required
string [ 1 .. 255 ] characters

Manufacturer name of the terminal

model
required
string [ 1 .. 255 ] characters

Model name of the terminal

serial
required
string [ 1 .. 255 ] characters

Serial(number) of the terminal

Responses

Response samples

Content type
application/json
{
  • "receipt": "string"
}

List transactions by terminal.

Authorizations:
ApiKeyAuth
path Parameters
manufacturer
required
string [ 1 .. 255 ] characters

Manufacturer name of the terminal

model
required
string [ 1 .. 255 ] characters

Model name of the terminal

serial
required
string [ 1 .. 255 ] characters

Serial(number) of the terminal

query Parameters
page
integer <int32> >= 1
Default: 1

The page number of your query result, starting at 1

size
integer <int32> [ 1 .. 100 ]
Default: 10

The amount of results per page, maximum 100 (defaults to 10)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new transaction for terminal.

The Merchant-API will make sure only one newly created transaction is available for a specific terminal. This means that when creating a new transaction, previous transaction(s) with status CREATED will be aborted. So given transactions A and B, when transaction A has not been retrieved by the terminal when creating transaction B the Merchant API will abort transaction A, and the terminal will receive transaction B.

Authorizations:
ApiKeyAuth
path Parameters
manufacturer
required
string [ 1 .. 255 ] characters

Manufacturer name of the terminal

model
required
string [ 1 .. 255 ] characters

Model name of the terminal

serial
required
string [ 1 .. 255 ] characters

Serial(number) of the terminal

Request Body schema: application/json
merchant_order_reference
required
string [ 1 .. 14 ] characters ([0-9a-zA-Z]|-|_){1,14}

Reference provided by the Merchant for future identification of this Transaction
This field may contain all letters in lowercase and uppercase, digit, underscore '_' and hyphen-minus '-'Usually a unique identifier generated by the Merchant

type
required
string (TransactionType)
Enum: "PURCHASE" "PRE_AUTH" "REFUND"
PURCHASE
Indicates a purchase where the money will flow from the consumer to the merchant
PRE_AUTH
Indicates a claim on a certain amount of money on the bankaccount of the consumer
REFUND
Indicates a refunds where the money will flow from the merchant back to the consumer
required
object (Amount)

Describes how much money the transaction should be.
'value' is a number value with a dot (.) as decimal separator. It should NOT have any digit grouping or thousands separators
'currency' is a 3-letter-code, compliant with ISO 4217

object or null

Reference object that represents a unique identifier for a transaction

Responses

Request samples

Content type
application/json
Example
{
  • "type": "PURCHASE",
  • "merchant_order_reference": "1234",
  • "amount": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creation_datetime": "2022-01-19T12:58:00Z",
  • "merchant_order_reference": "'TEN-103_1', '3987462423900', 'Q99PM-2QHFW-FQ'",
  • "brand": "string",
  • "system_trace_audit_number": "string",
  • "receipt": "string",
  • "merchant_receipt": "string",
  • "original_id": "string",
  • "authorization_code": "string",
  • "merchant_id": "string",
  • "processor_terminal_id": "string",
  • "type": "PURCHASE",
  • "amount": {
    },
  • "store": {
    },
  • "result": "APPROVED",
  • "status": "CREATED"
}

Get transaction by terminal and id.

Authorizations:
ApiKeyAuth
path Parameters
manufacturer
required
string [ 1 .. 255 ] characters

Manufacturer name of the terminal

model
required
string [ 1 .. 255 ] characters

Model name of the terminal

serial
required
string [ 1 .. 255 ] characters

Serial(number) of the terminal

id
required
string = 31 characters [0-9]{31}

Identifier of a transaction

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creation_datetime": "2022-01-19T12:58:00Z",
  • "merchant_order_reference": "'TEN-103_1', '3987462423900', 'Q99PM-2QHFW-FQ'",
  • "brand": "string",
  • "system_trace_audit_number": "string",
  • "receipt": "string",
  • "merchant_receipt": "string",
  • "original_id": "string",
  • "authorization_code": "string",
  • "merchant_id": "string",
  • "processor_terminal_id": "string",
  • "type": "PURCHASE",
  • "amount": {
    },
  • "store": {
    },
  • "result": "APPROVED",
  • "status": "CREATED"
}

Abort a transaction by terminal and id.

Authorizations:
ApiKeyAuth
path Parameters
manufacturer
required
string [ 1 .. 255 ] characters

Manufacturer name of the terminal

model
required
string [ 1 .. 255 ] characters

Model name of the terminal

serial
required
string [ 1 .. 255 ] characters

Serial(number) of the terminal

id
required
string = 31 characters [0-9]{31}

Identifier of a transaction

Responses

Version

Retrieves system information

Retrieving the system version.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
"1.0.0"