Create a direct collect request via the API (http POST or http GET)
Using the ‘create’ command a direct collect 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 direct collect request must be created. |
Example
https://api.paybylink.com/collect/create/e7140a88-cbba-4cc2-be9f-6e90536703ef
https://api.paybylink.com/collect/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 direct-collect-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. |
Return values
When the direct collect request could be created successfully, the unique key of the created direct collect request is returned.
If the direct collect request could not be created successfully, 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 direct collect request via API
https://api.paybylink.com/swagger/ui/index#/DirectCollectApi
Date updated: 2022-03-21
