Initialization

In your Server Code you include the paymill javascript library with the following command:

var paymill = require('paymill.apiomat');

After this you can access all paymill functions. To send requests to the paymill API you need an API Key. This key is located on the paymill website at My Account – Settings. To set the key call execute

paymill.initialize("<your_key>");

in your Server Code.

Services

Each endpoint of the paymill API has a corrseponding service. For example, to access client functions you can use paymill.clients.

Create a paymill client

To create a client in the paymill client we have to use the create method from paymill.clients. We create a new one with an email address

test@apiomat.com

and a description

A new test client

with the following command:

• JavaScript

You can handle response and errors by chaining then functions:

• JavaScript

Get details of a client

To retrieve details of a client call the following statement with a valid clientId.

• JavaScript

Create a new payment

A payment object is a representation of a credit card or direct debit payment.

Once you created a payment object, you can use the payment to create multiple transactions.

To create a new payment object for a client you need two things:

• A valid payment token (You must create this token on your client side and transfer it to your Server Code. See paymill js bridge how you get a valid token or use the native mobile SDKs )

• A valid client object (see above) or a client id

With this information you can create a new payment for a given client (clientDetail).

• JavaScript

Create a new transaction

The following method allows to create a new transaction with given payment details (paymentDetail) and client details or client ID (clientDetail).

• JavaScript

Create a new offer

Create a new offer with the following statement. This offer will cost 15 Euros and will be available every month.

To subscribe as client to a new offer you need offer details or id (offerDetail), payment details or id (payment) and you client details or id (clientDetail)

Complex example

Let’s create a new transaction for a existing client with a new payment.

We assume that we are created 2 classes in our dashboard ‘Client’ and ‘Item’.

‘Item’ Attributes:

• name – String: name of the item

• price – Number: price of the item

‘Client’ class has following attributes:

• foreignId – Contains the paymill client ID of existing client

• payToken – String: Here you have to save your payment token, from the paymill javascript bridge (see also ‘Create a new payment’ above; Notice that this token is only valid for 5 minutes)

• shoppedItems – Collection of references from class ‘Item’

We execute this request in our Server Code for class ‘Client’.

The Server Code function aom_afterPostRef will be executed when a reference to an object of class ‘Client’ is added .

The if statement in line 3 checks that transactions are only executed if a reference between a ‘Client’ and an ‘Item’ object was created.

• JavaScript