Create a mandate request via the API (http POST or http GET)

Using the ‘create’ command a mandate request can be created for a specific entity using the supplied values.
The <command> value in the URL must be replaced by: create/<entity key>
A secure connection, as described in the ‘API connection’ page, must be created.

URL PARAMETER	DESCRIPTION
entity key	Every PayByLink entity within the system has its own unique key. When connecting to the PayByLink system, this key must be supplied as well so PayByLink knows within which entity the payment must be created.

Example
https://api.paybylink.com/mandate/create/e7140a88-cbba-4cc2-be9f-6e90536703ef

Posted values

PARAMETER NAME	DESCRIPTION
MappingTemplate	With this parameter you can let the API know what mapping template must be used. If left empty: the default mandate mapping for that entity is used.
*	You can post any value to the API. Only those values that are used in the mapping template will be used but they are all logged in the system. Via HTTP-GET the parameters are part of the query-string. When using HTTP-POST also the query string can be used, but the body can also be posted via a JSON or XML string. The supplied content-type value determines how the body string must be handled. For a JSON string the content-type must be “application/json" or “text/x-json”. For an XML string the content-type must be “text/xml” or “application/xml”. The supplied string will be transformed to a name/value list and can then be used in the mapping. For instance this JSON string: { “amount”: 23.50, “customer”: “John Doe”, “contact” : { “mailAddress”: “john@doe.com”, “phoneNumber”: “026-1234567” } } will be transformed into 4 name/value pairs containing: ‘amount’, ‘customer’, ‘contact.mailAddress’ and ‘contact.phoneNumber’.

PARAMETER NAME

DESCRIPTION

MappingTemplate

With this parameter you can let the API know what mapping template must be used. If left empty: the default mandate mapping for that entity is used.

You can post any value to the API. Only those values that are used in the mapping template will be used but they are all logged in the system.

Via HTTP-GET the parameters are part of the query-string. When using HTTP-POST also the query string can be used, but the body can also be posted via a JSON or XML string. The supplied content-type value determines how the body string must be handled.
For a JSON string the content-type must be “application/json" or “text/x-json”.
For an XML string the content-type must be “text/xml” or “application/xml”.
The supplied string will be transformed to a name/value list and can then be used in the mapping.
For instance this JSON string: { “amount”: 23.50, “customer”: “John Doe”, “contact” : { “mailAddress”: “john@doe.com”, “phoneNumber”: “026-1234567” } } will be transformed into 4 name/value pairs containing: ‘amount’, ‘customer’, ‘contact.mailAddress’ and ‘contact.phoneNumber’.

Return values

When the mandate request could be created successfully, the Mandate URL is returned. This URL can also be used by the calling application to send within its own communication to the customer when 'SendType' = 'NoSend'.

If the mandate request could not be created succesfully, a ‘BadRequest’ with a describing message is returned. All the calls and parameters to and from the API are logged within the PayByLink system.

Test create a mandate request via API

https://api.paybylink.com/swagger/ui/index#/MandateApi

Date updated: 2022-03-21