Method list

Test your request

Changelog

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

return_id	int	Order return identifier.
show_full_history	bool	(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).

The method returns the data in JSON format.

status	varchar(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
payments	array	An array of payments list. Each payment contains fields described below.
| - 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	text	the currency
| - external_payment_id	text	external payment identifier
| - date	int	date of change record (unix time format)

Input data:
{ "return_id": 1102 } Output data:
{ "status": "SUCCESS", "payments": [ { "paid_before": "0.00", "paid_after": "55.00", "total_price": "82.97", "date": "1515001701", "currency": "GBP", "external_payment_id": "189a1236-0aa9-21ee-15ab-8b0992243303" } ] } A sample request in PHP:
<?php $methodParams = '{ "return_id": 1102 }'; $apiParams = [ "method" => "getOrderReturnPaymentsHistory", "parameters" => $methodParams ]; $curl = curl_init("https://api.baselinker.com/connector.php"); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_HTTPHEADER, ["X-BLToken: xxx"]); curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($apiParams)); $response = curl_exec($curl);