Find payments based on (a part of) an Order-ID
The API call is done through an http-GET request:
For the test environment:
https://testapi.paybylink.com/payment/search/<entityKey>?orderId=<OrderId>&exactSearch=<True/False>&getChildPaymentsToo=<True/False>&getPspPayments=<True/False>&getApiParameters=<True/False>&dateFrom=<date>&dateTo=<date>
For the production environment:
https://api.paybylink.com/payment/search/<entityKey>?orderId=<OrderId>&exactSearch=<True/False>&getChildPaymentsToo=<True/False>&getPspPayments=<True/False>&getApiParameters=<True/False>&dateFrom=<date>&dateTo=<date>
The following parameters can be used:
Name | Description | Mandatory |
|---|---|---|
| entityKey | The key of the entity for which the search takes place | Yes |
| orderId | The (part of) the order id for which payments are searched | Yes (minimal 5 characters) |
| exactSearch | True = Find the EXACT order id (default) False = Find an order id containing the submitted value | No (default = True) |
| getChildPaymentsToo | True = Also search in payments of which this entity is the 'parent' entity False = Search only within this specific entity | No (default = False) |
| getPspPayments | True = Also return the PSP payments of the payments found False = Do not return the PSP payments | No (default = False) |
| getApiParameters | True = Also return the API parameters of the payments found False = Do not the API parameters | No (default = False) |
| dateFrom | The creation date based on which the search has to start Format: 'yyyy-mm-dd HH:mm' | No (default = 6 months back) |
| dateTo | The creation date on which the search ends Format: 'yyyy-mm-dd HH:mm' (max. 6 months after dateFrom') | No (default = 'now') |
Example:
This call will return all payments only for the account with the entity key ‘8f9e8dad-530a-4dd7-9e95-a865f1fb5994’ that contain the value ‘12345’ in the order id:
'https://testapi.paybylink.com/payment/search/8f9e8dad-530a-4dd7-9e95-a865f1fb5994?orderId=12345&exactSearch=False'
