# Neuro-Pay Terminal API

# Requests

Collection of possible requests

# Create [POST]

<span style="background-color: #c2e0f4;">**https://api.neuro-admin.com/terminalpayment/terminal-payment/create**</span> \[POST\]

<table border="1" id="bkmrk-amount-int-smallest-" style="border-collapse: collapse; width: 100%; height: 555.516px;"><tbody><tr style="height: 80.1875px;"><td style="width: 33.2922%; height: 80.1875px;">amount</td><td style="width: 33.2922%; height: 80.1875px;">int</td><td style="width: 33.2922%; height: 80.1875px;">Smallest nominee for the currency. Example: 30SEK is 3000 öre so value of this param should be 3000. SEK is the only currency permitted.</td></tr><tr style="height: 46.5938px;"><td style="width: 33.2922%; height: 46.5938px;">terminal\_id</td><td style="width: 33.2922%; height: 46.5938px;">String</td><td style="width: 33.2922%; height: 46.5938px;">ID of the terminal where to send the payment</td></tr><tr style="height: 52.1875px;"><td style="width: 33.2922%; height: 52.1875px;">reference (optional)  
</td><td style="width: 33.2922%; height: 52.1875px;">String</td><td style="width: 33.2922%; height: 52.1875px;">Is a free text field to indicate a reference for the payment</td></tr><tr style="height: 63.3906px;"><td style="width: 33.2922%; height: 63.3906px;">sent\_via</td><td style="width: 33.2922%; height: 63.3906px;">Enum ("sms", "email")</td><td style="width: 33.2922%; height: 63.3906px;">Indicate with which media the receipt will sent (allowed values: "sms", "email")</td></tr><tr style="height: 63.3906px;"><td style="width: 33.2922%; height: 63.3906px;">sent\_to</td><td style="width: 33.2922%; height: 63.3906px;">String</td><td style="width: 33.2922%; height: 63.3906px;">Indicate phone number or mail where to send the receipt</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/scaled-1680-/o9himage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/o9himage.png)

# Check Status [POST]

<span style="background-color: #c2e0f4;">**https://api.neuro-admin.com/terminalpayment/terminal-payment/check-status**</span> \[POST\]

Values

<table border="1" id="bkmrk-checkout_id-string-t" style="border-collapse: collapse; width: 100%;"><tbody><tr><td style="width: 33.2922%;">payment\_id</td><td style="width: 33.2922%;">String</td><td style="width: 33.2922%;">The payment\_id received when creating a terminal payment object</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/scaled-1680-/UBQimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/UBQimage.png)

# Refund [POST]

<span style="background-color: #c2e0f4;">**[https://api.paiwise.com/terminalpayment/terminal-payment/refund](https://api.paiwise.com/terminalpayment/terminal-payment/refund)**</span> \[POST\]

The refund can be used on objects that has status “paid” or “partialRefund”

Values

<table border="1" id="bkmrk-checkout_id-string-t" style="border-collapse: collapse; width: 103.58%;"><tbody><tr><td style="width: 33.3745%;">payment\_id</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">The payment\_id received when creating a terminal payment object</td></tr><tr><td style="width: 33.3745%;">amount (optional)</td><td style="width: 33.3745%;">Int</td><td style="width: 33.3745%;">If an amount to be refunded is not set the whole actual balance will be refunded</td></tr><tr><td style="width: 33.3745%;">reason (optional)</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">Reason of the refund. Value admitted: "duplicate", "requested\_by\_customer" or "fraudolent"</td></tr><tr><td style="width: 33.3745%;">refundDetails (optional)</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">Comments about the refund. Free text</td></tr><tr><td style="width: 33.3745%;">sent\_via (optional) (beta)</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">Notification method. Value admitted: "email" or "sms"</td></tr><tr><td style="width: 33.3745%;">sent\_to (optional) (beta)</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">To whom send notification of the refund</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-09/scaled-1680-/iUgimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-09/iUgimage.png)

# Cancel [POST]

<span style="background-color: #c2e0f4;">**https://api.neuro-admin.com/terminalpayment/terminal-payment/cancel**</span> \[POST\]

The update can be used on objects with every status to update/add/delete metadata information.

Values

<table border="1" id="bkmrk-checkout_id-string-t" style="border-collapse: collapse; width: 103.58%;"><tbody><tr><td style="width: 33.3745%;">payment\_id</td><td style="width: 33.3745%;">String</td><td style="width: 33.3745%;">The payment\_id received when creating a terminal payment object</td></tr></tbody></table>

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/scaled-1680-/C8Nimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/C8Nimage.png)

# Authentification

In order to use the terminal API the company in question needs to generate an API key through the Neuor-Admin platform. Said API key should be sent as a bearer token in each request.

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2022-07/scaled-1680-/jgfimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2022-07/jgfimage.png)

# Response



# The response object

For each endpoint the terminal object will be returned in its “new state”  
Example:

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/scaled-1680-/axIimage.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/axIimage.png)

Possible statuses are  
• created  
• canceled  
• paid  
• refunded  
• partialRefund

Every date and time returned are in UTC.

# Terminal's request



# Available Reader [GET]

<span style="background-color: #c2e0f4;">**https://api.neuro-admin.com/terminalpayment/terminal-payment/available-reader**</span> \[GET\]

The available-reader EP can be used to retrieve the list of available terminals that are online at the moment of the request

[![image.png](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/scaled-1680-/image.png)](https://wiki.paiwise.tech/uploads/images/gallery/2023-06/image.png)

# Data format

The API currently accepts and returns JSON data in the body

# Postman collection

attached to this page is a postman collection for testing

All requests inherits the authentication from the collection. as the bearer token you add your API key test or live,  
  
You can find file attachments in top left corner of this page