Local daemon setup

Authentication

In order to make requests to the local daemon, you need to receive a authorization token for a specific terminal, this authorisation token can be validated offline. In order to receive the authorisation token you need to make the request to the brouwer vos api. Using this access token you will be able to make requests to the payments endpoint on the terminal.

1. Request a access token from this access token endpoint.

2. Use this access token as the pairing_code in the pair request.

   1. Note: that for POS terminals you can submit also the serial number of the device, and read the terminal_id field to read the terminal id.

If the pair request results in true, than the terminal will be made ready for operation. It is possible that the terminal restarts once or twice before its ready for operation.

Creating payments

We recommend using the cloud api as you have more control over the flow of funds. But if you just require to 'create payments' than you will have enough options with the endpoints listed below.

The required fields of the payment creation api are: amount, currency, description.

If you already have a internal payment ID, you can use this to initiate the payment, without supplying any other information.

---

Obtain

post

Retrieve an access token using client credentials.

Authorizations

bearerAuth

Body

application/json

pairing_codestringOptional

The pairing code obtained from

Responses

200

Access token successfully obtained.

application/json

400

Invalid request parameters.

401

Unauthorized - Invalid client credentials.

post

/v1/pair

HTTPcURLJavaScriptPython

POST /v1/pair HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "pairing_code": "text"
}

{
  "result": true,
  "terminal_id": "text"
}

Get a payment

get

Get the status of a payment

Authorizations

bearerAuth

Query parameters

payment_idstringRequired

Unique identifier of the payment.

Responses

200

A list of payments for the specified company.

application/json

404

Payment not found.

get

/v1/payments

HTTPcURLJavaScriptPython

GET /v1/payments?payment_id=text HTTP/1.1
Host: localhost:8080
Accept: */*

{
  "id": "text",
  "amount": 1,
  "currency": "AED",
  "state": "created",
  "description": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Create a Payment for a Company

post

Create a new payment associated with a specified company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

Body

application/json

payment_idstring | nullableOptional

amountnumberOptional

currencystring · enumOptionalPossible values:

descriptionstring | nullableOptional

Responses

201

Payment created successfully.

application/json

400

Invalid request data.

404

Company not found.

post

/v1/payments

HTTPcURLJavaScriptPython

POST /v1/payments HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "payment_id": "text",
  "amount": 1,
  "currency": "AED",
  "description": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "id": "text",
  "amount": 1,
  "currency": "AED",
  "state": "created",
  "description": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}