getOrderPaymentsHistory
Metoda umożliwia pobranie historii płatności dla wybranego zamówienia, w tym zewnętrznego identyfikatora płatności z bramki płatniczej. Jedno zamówienie może mieć wiele wpisów w historii płatności, spowodowanych przez dopłaty, zmiany wartości zamówienia, ręczną edycję płatności.
Parametry wejściowe
Dane wyjściowe:
Przykładowe wywołanie w php:
| order_id | int | Identyfikator zamówienia z managera zamówień BaseLinker |
| show_full_history | bool | (nieobowiązkowe, domyślnie false) Pobieraj pełną historię płatności, także wpisy o zmianie wartości zamówienia, ręczne edycje płatności w zamówieniu. Domyślnie false - zwraca jedynie wpisy zawierające zewnętrzny identyfikator płatności (najczęściej wykorzystywane). |
Dane wyjściowe
Metoda zwraca dane w formacie JSON.
| status | varchar(30) | SUCCESS - poprawnie wykonano zapytanie ERROR - wystąpił bład podczas zapytania API. Szczegóły błedu opisane będą w 2 dodatkowych zwracanych polach: error_message i error_code |
| payments | array | Tablica z listą płatności. Każda płatność zawiera pola: paid_before (float) - łączna zapłacona kwota przed daną zmianią paid_after (float) - łączna zapłacona kwota po danej zmianie total_price (float) - cena całkowita zamówienia currency (varchar) - waluta external_payment_id (varchar) - zewnętrzny identyfikator płatności date (int) - data zarejestrowania zmiany (format unix time) |
Przykład
Dane wejściowe:Dane wyjściowe:
Przykładowe wywołanie w php:
Dokumentacja API