API documentation
Method list
Test your request
Changelog


getOrderPaymentsHistory
The method allows you to retrieve payment history for a selected order, including an external payment identifier from the payment gateway. One order can have multiple payment history entries, caused by surcharges, order value changes, manual payment editing


Input parameters
order_idintOrder Identifier from BaseLinker order manager
show_full_historybool(optional, false by default) Download full payment history, including order value change entries, manual order payment edits. False by default - only returns entries containing an external payment identifier (most commonly used)



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
paymentsarrayAn array of payments list. Each payment contains fields:
paid_before (float) - total amount paid before the given change
paid_after (float) - total amount paid after the change
total_price (float) - total order price
currency (varchar) - the currency
external_payment_id (varchar) - external payment identifier
date (int) - date of change record (unix time format)



Sample
Input data:
Output data:
A sample request in php: