INFO

This endpoint can be accessed with the following API type: pos-payment.

TIP

Don't have an API key? Create one in your Customer Area with the type pos-payment, go to Developers -> Api Credentials.

INFO

When Stopping a NFC Transaction, the API key needs to have the same store ID as the linked Adyen POS terminal, otherwise it will fail to stop the NFC transaction. Use Connected Terminals to get the linked terminals to a store.

Stop NFC Transaction

When you are done applying your business logic, you can stop the ongoing loading screen on the terminal.

Displaying the result

In the display_output you can provide the following values:

header

icon

footer

Response

Response `event` statuses

success (200) A NFC Transaction has been successfully stopped

success -> merchantabort (200) A NFC Transaction didn't officially start, and we executed a Merchant Abort to return to the terminal to status initialised.

failure (400) Failed to stop a NFC Transaction

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

pos_id

string

required

The ID of your POS unit

terminal_id

string

required

The ID of the pysical Adyen terminal

display_output

object | null

required

Show your own message when ending the card acquisition with a cancellation

header

string

required

Header text above the icon

icon

string

required

Icon to show

Examples:

AcceptedAcceptedAnimatedDeclinedDeclinedAnimatedIdle

footer

string

required

Footer text below the icon

Example

{"pos_id":"willekeurig","terminal_id":"P400Plus-00000000","display_output":{"icon":"AcceptedAnimated","header":"Success","footer":"Have a great day!"}}

Responses

🟢200Success

application/json

Body

event_type

string

required

The sent Adyen event message type

event

string

required

Status of the NFC Stop request

Examples:

successfailureinprogress

event_condition

string

required

If event == failed a reason will be provided

store_id

string

required

The Store ID associated with the API Key

terminal_id

string

required

The ID of the pysical Adyen terminal

pos_id

string

required

The ID of your POS unit

metadata

object | null

required

The metadata you provided

your_info

string

required

adyen_response

object

required

The raw adyen response

SaleToPOIResponse

object

required

adyen_error_log

array[string]

required

When an Adyen Exception happens on Bavindo's side the readable errors will be passed through

environment

string

required

The environment the API key is working on

Examples:

livetest

Examples

Success (200)Success -> Merchant Abort (200)Failure (400)

{
    "event_type": "service.enableservice.response",
    "event": "success",
    "event_condition": null,
    "store_id": "3294V22322755KZ6TWHGPRJ",
    "terminal_id": "P400Plus-00000000",
    "pos_id": "willekeurig",
    "metadata": {
        "your_info": "123456789"
    },
    "adyen_response": {
        "SaleToPOIResponse": {
            "EnableServiceResponse": {
                "Response": {
                    "Result": "Success"
                }
            },
            "MessageHeader": {
                "MessageCategory": "EnableService",
                "MessageClass": "Service",
                "MessageType": "Response",
                "POIID": "P400Plus-806706769",
                "ProtocolVersion": "3.0",
                "SaleID": "willekeurig",
                "ServiceID": "45215d45"
            }
        }
    },
    "adyen_error_log": [],
    "environment": "test"
}

NFC Transaction Stop

Stop NFC Transaction#

Displaying the result#

Response#

Response event statuses#

Request

Responses

Stop NFC Transaction

Displaying the result

Response

Response `event` statuses