This document describes the handling of the API and the basic concepts of sending payment requests and how to get updates when a buyer paid the payments.

The API is a JSON REST API which reports every information in Realtime. There are no batch processes involved. (an additional Webhook will be released soon)

1. User An User can signup and us the service for free. All users are identified via the email address.

2. Organizations To send a payment request an user has to create an organizations, which holds the information about organization address, target iban, allowed payment methods An organization can have multiple users with different roles.

3. Orders and Payments The payment request is call order within the API. Every order belongs to an organization and an creator user. When a payer does a payment the order will be updated with the information regarding the payment status.

1. Every Organization has (without a contract) the ability to send only 2 orders and invite one additional user.
   1. If you use the Staging Enviroment and it is down more than 10 Minutes, please inform us, that you need this enviroment.
   2. If you miss any API Endpoint, we may have not documented the endpoint yet, just ask us and we are happy to help you.

1. You create a new payment request (order)

    POST [API]/order
    {
      "name": "Zahlung #123", // public name
      "price": 1000000, // price in euro cent
      "orgId": "abcdef", // organization id
    }
   
    // response
    {
      "id": "BJ8ivGHSKq", // order reference
      ...
    }

2. (Optional) You send the order via E-Mail

    POST [API]/order/:orderid/recipient
    {
      "recipient" : {
        "email": "mail@example.com"
      }
    }
   
    //response
    { ... }

3. Payer will receive the payment request via email (from Bezahl.de) or direct from the Dealer

4. Payer will choose one of the payment methods and will start the payment process

5. Every status update is requestable via API

    GET [API]/order/:orderid
   
    //response
    {
      "status": "open",
      ...
    }

We provide different systems for you to access the bezahl.de API

• Frontend: https://mein.bezahl.de
• API: https://mein.sicherbezahlen.de/nxt/v1/[path]

• Frontend: https://partner.bezahl.de
• API: https://partner.staging.sicherbezahlen.de/nxt/v1/[path] (Hostname for Staging may change in near future)

For the Authentication with our System we provide a Token which you can generate at [host]/clients.

Then the user receives a token which should be provided for each Call as NX-Token Header.

1. Now you can access the API in the name of the user with the HTTP Header NX-Token.

    curl -X GET \
      https://partner.staging.sicherbezahlen.de/nxt/v1/user \
      -H 'Content-Type: application/json' \
      -H 'NX-Token: [token]'

1. login

    curl -X POST \
      https://partner.staging.sicherbezahlen.de/nxt/v1/auth/login \
      -H 'Content-Type: application/json' \
      -d '{
        "email": "",
        "password": ""
      }'

2. grap the temporary token from the Response and put at [TOKEN]

    curl -X POST \
      https://partner.staging.sicherbezahlen.de/nxt/v1/auth/token \
      -H 'Content-Type: application/json' \
      -H 'NX-Token: [TOKEN]' \
      -d '{
        "expiresIn": "86400",
        "description": "generic api token or put your name in it"
      }'
    // expiresIn: provides the expires seconds from now.
    // description: any description you want to provide to the user
   
    // response
    {
      "token": "[TOKEN]"
    }

If you have any questions, don't hesitate to contact us at dev@nx-technologies.com or our customer service at https://bezahl.de.

information about the user

maintain an organization

create and track status of an order