Funkcjonalność | Środowisko | URL |
---|---|---|
Serwer API | Produkcyjne | https://api.fiberpay.pl/1.0 |
Panel deweloperski | Produkcyjne | https://fiberpay.pl |
Serwer API | Testowe | https://apitest.fiberpay.pl/1.0 |
Panel deweloperski | Testowe | https://test.fiberpay.pl |
Są to zupełnie rozdzielone środowiska (łącznie z infrastrukturą). Klucze API z jednego środowiska nie będą działać w drugim.
Do korzystania z API konieczne jest wygenerowanie kluczy:
- jawnego (publicKey) - używanego do przesyłania w ramach żądań API
- tajnego (secretKey) - używanego do podpisywania żądań (nigdy nie powinien by przesyłany lub ujawniany)
Klucze możesz wygenerować korzystając z panelu użytkownika Fiberpay.
Fiberpay posiada publicznie dostępną bibliotekę umożliwiającą komunikację z API utworzoną w języku PHP.
Jej instalacja możliwa jest przy użyciu narzędzia Composer [link]
composer require fiberpay/fiberpay-php
Każde żądanie do API powinno posiadać następujące nagłówki:
- Content-Type - application/json
- Accept - application/json
- X-API-Route – informacja o wywoływanej metodzie HTTP oraz URI
- np.
POST /1.0/orders/collect
- np.
GET /1.0/orders/collect/12345678
- np.
- X-API-Nonce – nonce w postaci liczba naturalnej, każdy następny nonce powinien być większy od poprzedniego (przykładowo można użyć timestampa lub zaokrąglonego microtime jeśli używamy PHP)
- X-API-Key – wygenerowany klucz jawny
- X-API-Signature – podpis z użyciem skrótu sha512 stworzonego przy użyciu ‘route’, ‘nonce’, ‘apiKey’, ‘requestBody’ i ‘secretKey’
Jest to wartość w postaci liczby naturalnej, która jest zapisywana przy każdym żądaniu API. Każde kolejne żądanie API powinno posiadać wartość nonce, które będzie większe od poprzednio zapisanego. Nonce przypisane jest do własnego klucza API, więc w przypadku wykorzystywania większej ilości systemów, warto utworzyć klucz API dla każdej instancji. Dobrym przykładem nonce jest wartość timestampa aktualnego czasu, który powinien z każdym kolejnym żądaniem być wartością większą od poprzedniej.
Przykład: Wykonując żądanie API do systemu z ustawionym nagłówkiem X-API-Nonce = 1, następne żądanie API do systemu powinno mieć nagłowek X-API-Nonce większy od 1 np. X-API-Nonce = 2. I dalej kolejne żądanie powinno mieć nagłowek większy od poprzedniego, czyli X-API-Nonce > 2.
Należy utworzyć połączony ciąg znaków (concatenated string) składający się z route, nonce, apiKey oraz requestBody (kolejność ma znaczenie!).
Wartość requestBody to treść (body) żądania HTTP, które przesyłamy do API. W wybranych przypadkach wartość requestBody będzie pusta, bo całość wywołania API może ograniczać się do URLa (np. GET /1.0/orders/collect/12345678
). W takim przypadku należy użyć pustego ciągu tekstowego ('').
Następnie należy wygenerować skrót sha512 z utworzonego ciągu używając secretKey.
Przykładowa implementacja w PHP:
$implodeParams = implode( ‘’, [$route, $nonce, $apiKey, $requestBody]);
hash_hmac(‘sha512’, $implodeParams, $secretKey)
FiberPay posiada mechanizm tzw. callbacków. Po aktualizacji zlecenia system FiberPay może wywołać żądanie HTTP na wskazany uprzednio adres, gdzie:
- w ciele (body) żądania będzie zawarty token JWT z aktualnymi danymi zlecenia,
- w nagłówku API-Key(header) żądania będzie zawarty jawny klucz API, wskazujacy który klucz tajny został wykorzystany do utworzenia JWT.
Token JWT należy odkodować używając algorytmu HS256 oraz klucza tajnego. Jeśli sygnatura tokenu zgadza się po odszyfrowaniu, to znaczy, że dane są prawdziwe i zostały wysłane przez FiberPay.
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXlsb2FkIjp7Im9yZGVySXRlbSI6eyJkYXRhIjp7ImNvZGUiOiJmdGU1bnljcSIsInN0YXR1cyI6InJlY2VpdmVkIiwidHlwZSI6ImNvbGxlY3RfaXRlbSIsImN1cnJlbmN5IjoiUExOIiwiYW1vdW50IjoiMTAwLjAwIiwiZmVlcyI6W10sInRvTmFtZSI6IkphbiBLb3dhbHNraSIsInBhcmVudENvZGUiOiJkejh5bjdncWZwcjYiLCJkZXNjcmlwdGlvbiI6IlNhbGFyeSBwYXltZW50IiwibWV0YWRhdGEiOm51bGwsImNyZWF0ZWRBdCI6IjIwMjEtMDUtMTEgMTI6MjU6MzIiLCJ1cGRhdGVkQXQiOiIyMDIxLTA1LTExIDEyOjI2OjAyIiwicmVkaXJlY3QiOiJodHRwczpcL1wvdGVzdC5maWJlcnBheS5wbFwvb3JkZXJcL2Z0ZTVueWNxIn0sImludm9pY2UiOnsiYW1vdW50IjoiMTAwLjAwIiwiY3VycmVuY3kiOiJQTE4iLCJpYmFuIjoiUEwxOTE5NDAxMDc2MzIwMjgwMTAwMDAyVEVTVCIsImJiYW4iOiIxOTE5NDAxMDc2MzIwMjgwMTAwMDAyVEVTVCIsImRlc2NyaXB0aW9uIjoiZnRlNW55Y3EifSwibGlua3MiOnsicmVsIjoic2VsZiIsImhyZWYiOiJodHRwczpcL1wvYXBpdGVzdC5maWJlcnBheS5wbFwvMS4wXC9vcmRlcnNcL2NvbGxlY3RcL2l0ZW1cL2Z0ZTVueWNxIn19LCJ0cmFuc2FjdGlvbiI6eyJkYXRhIjp7ImNvbnRyYWN0b3JOYW1lIjoiVEVTVCIsImNvbnRyYWN0b3JJYmFuIjoiUEwxMjM0MDAwMFRFU1QiLCJhbW91bnQiOiIxMDAuMDAiLCJjdXJyZW5jeSI6IlBMTiIsImRlc2NyaXB0aW9uIjoiZnRlNW55Y3EiLCJiYW5rUmVmZXJlbmNlQ29kZSI6ImZ0ZTVueWNxIiwib3BlcmF0aW9uQ29kZSI6ImZ0ZTVueWNxIiwiYWNjb3VudEliYW4iOiJQTDE5MTk0MDEwNzYzMjAyODAxMDAwMDJURVNUIiwiYm9va2VkQXQiOiIyMDIxLTA1LTExIDEyOjI1OjUwIiwiY3JlYXRlZEF0IjoiMjAyMS0wNS0xMSAxMjoyNTo1MCIsInVwZGF0ZWRBdCI6IjIwMjEtMDUtMTEgMTI6MjY6MDIifSwidHlwZSI6ImJhbmtUcmFuc2FjdGlvbiJ9LCJ0eXBlIjoiY29sbGVjdF9vcmRlcl9pdGVtX3JlY2VpdmVkIiwiY3VzdG9tUGFyYW1zIjpudWxsfSwiaXNzIjoiRmliZXJwYXkiLCJpYXQiOjE2MjA3ODYzNjJ9.cQgcBYDF13P64WOLBT9slzxEoC-7ln_9iIDoSVVONr0
{
"payload": {
"orderItem": {
"data": {
"code": "2c36wknyq7uz",
"status": "completed",
"type": "direct",
"description": "Salary payment",
"currency": "PLN",
"amount": "100.0000",
"fees": [
{
"amount": "0.50",
"currency": "PLN",
"type": "subtraction"
}
],
"feeAmountSum": "0.50",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"redirect": "http://localhost:3000/order/2c36wknyq7uz",
"metadata": null,
"createdAt": "2022-12-27 12:21:37",
"updatedAt": "2022-12-27 12:24:07"
},
"invoice": {
"code": "b74nm6ckq",
"amount": "100.00",
"currency": "PLN",
"createdAt": "2022-12-27 12:21:37",
"updatedAt": "2022-12-27 12:23:15"
},
"links": {
"rel": "self",
"href": "https://3d51-89-64-64-11.eu.ngrok.io/1.0/orders/direct/2c36wknyq7uz"
}
},
"transaction": {
"data": {
"contractorName": "Michał",
"contractorIban": "PL27114020040000300201355387",
"amount": "-99.50",
"currency": "PLN",
"description": "5jucvt6d Salary payment",
"bankReferenceCode": "fyv7qx89b5j2",
"operationCode": "fyv7qx89b5j2",
"accountIban": "PL123400007",
"bookedAt": "2022-12-27 12:23:59",
"createdAt": "2022-12-27 12:23:59",
"updatedAt": "2022-12-27 12:24:07"
},
"type": "bankTransaction"
},
"type": "direct_order_sent"
},
"iss": "Fiberpay",
"iat": 1679401850
}
Informacje jak odkodować lub jakich bibliotek użyć do obsługi tokenu JWT znajdziesz pod adresem: https://jwt.io/
Możliwe jest pobranie za pośrednictwem API informacji o fakturach wystawionych przez nas za zrealizowane usługi.
Pobranie informacji o wystawionych fakturach
Przykładowa odpowiedź serwera:
{
"data": [
{
"data": {
"code": "8vdf57y9zwqe",
"number": "FP/bcde/2021/03/1",
"amount": 100,
"currency": "PLN",
"downloadUrl": "https://fiberpay.fakturownia.net/f/FP-bcde-2021-03-1/ZYzAfJL0f0LnKLajhsdM.pdf",
"billingPeriod": "2021-03",
"issueDate": "2021-04-01"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/invoices/8vdf57y9zwqe"
}
},
{
"data": {
"code": "5ped9nrvyzs3",
"number": "FP/bcde/2021/03/2",
"amount": 500,
"currency": "PLN",
"downloadUrl": "https://fiberpay.fakturownia.net/f/FP-bcde-2021-03-2/mrWTlweIAPpdrbgBop80.pdf",
"billingPeriod": "2021-03",
"issueDate": "2021-04-01"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/invoices/5ped9nrvyzs3"
}
}
],
"links": {
"first": "https://apitest.fiberpay.pl/1.0/invoices?page=1",
"last": "https://apitest.fiberpay.pl/1.0/invoices?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://apitest.fiberpay.pl/1.0/invoices?page=1",
"label": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://apitest.fiberpay.pl/1.0/invoices",
"per_page": 15,
"to": 4,
"total": 4
}
}
Pobranie informacji o pojedynczej fakturze
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod faktury |
Przykładowa odpowiedź serwera:
{
"data": {
"code": "c7r3j5xaw9v8",
"number": "FP/bcde/2021/03/3",
"amount": 19,
"currency": "PLN",
"downloadUrl": "https://fiberpay.fakturownia.net/f/FP-bcde-2021-03-3/vV0Wlx2GX96ZZzQXp.pdf",
"billingPeriod": "2021-03",
"issueDate": "2021-04-01",
"orders": {
"data": [
{
"data": {
"code": "685ztudjnmk2",
"status": "completed",
"type": "forward",
"currency": "PLN",
"targetAmount": "1800.0000",
"targetName": "targetName",
"targetIban": "PL61109010140000071219812874",
"targetDescription": "targetDescription",
"brokerAmount": "181.0000",
"brokerName": "targetName",
"brokerIban": "PL61109010140000071219812874",
"feeAmount": "19.00",
"redirectUrl": null,
"beforePaymentInfo": null,
"afterPaymentInfo": null,
"createdAt": "2021-04-09 12:44:21",
"updatedAt": "2021-04-09 12:44:21"
},
"invoice": {
"amount": "2000.00",
"currency": "PLN",
"iban": "PL123400005",
"bban": "123400005",
"description": "g92e3nb6"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/forward/685ztudjnmk2"
}
}
],
"links": {
"first": "https://apitest.fiberpay.pl/1.0/invoices/c7r3j5xaw9v8?page=1",
"last": "https://apitest.fiberpay.pl/1.0/invoices/c7r3j5xaw9v8?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://apitest.fiberpay.pl/1.0/invoices/c7r3j5xaw9v8?page=1",
"label": 1,
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://apitest.fiberpay.pl/1.0/invoices/c7r3j5xaw9v8",
"per_page": 15,
"to": 1,
"total": 1
}
}
}
}
Pobranie informacji o rozliczeniach
Przykładowa odpowiedź serwera:
{
"data": [
{
"data": {
"code": "6a3mukzxtv",
"status": "open",
"amount": "0.0000",
"feeAmount": "0.0000",
"currency": "PLN",
"closedAt": null,
"createdAt": "2021-04-08 11:43:05",
"updatedAt": "2021-04-08 11:43:05"
}
},
{
"data": {
"code": "w6ny79cqma",
"status": "open",
"amount": "0.0000",
"feeAmount": "0.0000",
"currency": "PLN",
"closedAt": null,
"createdAt": "2021-04-09 11:09:15",
"updatedAt": "2021-04-09 11:09:15"
}
}
]
}
Pobranie informacji o pojedynczym rozliczeniu
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod rozliczenia |
Przykładowa odpowiedź serwera:
{
"data": {
"code": "4jscrftnk5",
"status": "open",
"amount": "0.0000",
"feeAmount": "0.0000",
"currency": "PLN",
"closedAt": null,
"createdAt": "2021-04-09 12:03:33",
"updatedAt": "2021-04-09 12:03:33"
}
}
Usługa pojedynczego przekazu pieniężnego na wskazane konto bankowe. Platforma korzystająca z API dostanie powiadomienie, gdy dany przekaz zostanie opłacony, a następnie gdy Fiberpay przekaże środki na docelowe konto.
Utworzenie zlecenia. Parametry żądania:
Parametr | Wymagane | Opis |
---|---|---|
amount | tak | kwota przekazu, decimal z maks. 2 miejscami po przecinku (np. 100.50) |
currency | tak | waluta (aktualnie dostępne tylko PLN) |
toName | tak | nazwa odbiorcy |
toIban | tak | IBAN odbiorcy |
description | nie | tytuł przelewu |
metadata | nie | opcjonalne dane przekazywane przez FiberPay w odpowiedzi |
callbackUrl | nie | URL na który ma być wywołany callback |
callbackParams | nie | opcjonalne parametry callbacka |
Przykładowa odpowiedź serwera
{
"data": {
"code": "gjrbwhcx96v7",
"status": "defined",
"type": "direct",
"currency": "PLN",
"amount": "100.0000",
"feeAmount": "0.5000",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"metadata": null,
"createdAt": "2020-09-18 17:02:42",
"updatedAt": "2020-09-18 17:02:42"
},
"invoice": {
"amount": "100.50",
"currency": "PLN",
"iban": "PL123400007",
"description": "gjrbwhcx96v7"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/direct/gjrbwhcx96v7"
}
}
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod zlecenia |
Przykładowa odpowiedź serwera:
{
"data": {
"code": "gjrbwhcx96v7",
"status": "defined",
"type": "direct",
"currency": "PLN",
"amount": "100.0000",
"feeAmount": "0.5000",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"metadata": null,
"createdAt": "2020-09-18 17:02:42",
"updatedAt": "2020-09-18 17:02:42"
},
"invoice": {
"amount": "100.50",
"currency": "PLN",
"iban": "PL123400007",
"description": "gjrbwhcx96v7"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/direct/gjrbwhcx96v7"
}
}
Anulowanie wcześniej utworzonego zlecenia (możliwe tylko dla jeszcze nieopłaconych zleceń).
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod zlecenia |
{
"data": {
"code": "gjrbwhcx96v7",
"status": "cancelled",
"type": "direct",
"currency": "PLN",
"amount": "100.0000",
"feeAmount": "0.5000",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"metadata": null,
"createdAt": "2020-09-18 17:02:42",
"updatedAt": "2020-09-18 17:03:34"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/direct/gjrbwhcx96v7"
}
}
Usługa FiberSplit jest stosowana do obsługi masowych wypłat środków do wielu odbiorców. Pozwala wykonać wiele przekazów pieniężnych opłaconych jednym przelewem - przykładowo może to być 100 przelewów na wskazane konta bankowe po 100 zł zrealizowane w wyniku zasilenia zlecenia przelewem na 10.000 zł. Aplikacja korzystająca z API po założeniu zlecenia tego typu dostanie powiadomienie, gdy zostanie ono opłacone przelewem zasilającym. Następnie aplikacja będzie otrzymywała powiadomienia dot. statusu każdego ze jednostkowych przekazów pieniężnych w zleceniu.
Aby skorzystać z usługi należy:
- założyć zlecenie (POST /orders/split)
- dodać poszczególne przekazy pieniężne (POST /orders/split/item)
- zakończyć definicję zlecenia (PUT /orders/split/{code}/define)
- opłacić utworzone zlecenie
Tworzy zlecenie
Parametr | Wymagane | Opis |
---|---|---|
currency | tak | waluta zlecenia (aktualnie wspieramy tylko PLN) |
metadata | nie | opcjonalne dane przekazywane przez FiberPay w callbacku |
Przykładowa odpowiedź
{
"data": {
"code": "zc6ta75gfpme",
"status": "open",
"type": "split",
"currency": "PLN",
"metadata": null,
"createdAt": "2020-09-18 17:05:32",
"updatedAt": "2020-09-18 17:05:32",
"items": []
},
"invoice": {
"amount": "0.00",
"currency": "PLN",
"iban": null,
"description": "zc6ta75gfpme"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/split/zc6ta75gfpme"
}
}
Tworzy pojedynczy przelew do wysłania w ramach całego zlecenia.
Parametr | Wymagane | Opis |
---|---|---|
amount | tak | kwota przelewu |
currency | tak | waluta przelewu (aktualnie wspierane tylko PLN) |
parentCode | tak | kod zlecenia nadrzędnego |
toName | tak | nazwa odbiorcy |
toIban | tak | IBAN odbiorcy |
description | tak | tytuł przelewu |
metadata | nie | opcjonalne dane przekazywane przez FiberPay w odpowiedzi, |
callbackUrl | nie | URL na który ma być wywołany callback |
callbackParams | nie | opcjonalne parametry callbacka |
Przykładowa odpowiedź
{
"data": {
"code": "gmats9v3",
"description": "testowy przelew",
"status": "open",
"type": "split_item",
"currency": "PLN",
"amount": "100",
"feeAmount": "1.50",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"parentCode": "m9cqbfhk5x4e",
"metadata": null,
"createdAt": "2020-09-18 17:07:53",
"updatedAt": "2020-09-18 17:07:53"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/split/item/gmats9v3"
}
}
Kończy tworzenie orderu (zamyka definicję).
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod zlecenia |
Przykładowa odpowiedź:
{
"data": {
"code": "m9cqbfhk5x4e",
"status": "defined",
"type": "split",
"currency": "PLN",
"metadata": null,
"createdAt": "2020-09-18 17:06:30",
"updatedAt": "2020-09-18 17:08:38",
"items": [
{
"data": {
"code": "gmats9v3",
"description": "testowy przelew",
"status": "open",
"type": "split_item",
"currency": "PLN",
"amount": "100.0000",
"feeAmount": "1.5000",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"parentCode": "m9cqbfhk5x4e",
"metadata": null,
"createdAt": "2020-09-18 17:07:53",
"updatedAt": "2020-09-18 17:07:53"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/split/item/gmats9v3"
}
}
]
},
"invoice": {
"amount": "101.50",
"currency": "PLN",
"iban": "PL123400003",
"description": "m9cqbfhk5x4e"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/split/m9cqbfhk5x4e"
}
}
Pobranie informacji o całym zleceniu
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod zlecenia |
Przykładowa odpowiedź serwera:
{
"data": {
"code": "m9cqbfhk5x4e",
"status": "defined",
"type": "split",
"currency": "PLN",
"metadata": null,
"createdAt": "2020-09-18 17:06:30",
"updatedAt": "2020-09-18 17:08:38",
"items": [
{
"data": {
"code": "gmats9v3",
"description": "testowy przelew",
"status": "open",
"type": "split_item",
"currency": "PLN",
"amount": "100.0000",
"feeAmount": "1.5000",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"parentCode": "m9cqbfhk5x4e",
"metadata": null,
"createdAt": "2020-09-18 17:07:53",
"updatedAt": "2020-09-18 17:07:53"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/split/item/gmats9v3"
}
}
]
},
"invoice": {
"amount": "101.50",
"currency": "PLN",
"iban": "PL123400003",
"description": "m9cqbfhk5x4e"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/split/m9cqbfhk5x4e"
}
}
Pobranie informacji o poszczególnym przekazie pieniężnym
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod zlecenia |
Przykładowa odpowiedź serwera:
{
"data": {
"code": "gmats9v3",
"description": "testowy przelew",
"status": "open",
"type": "split_item",
"currency": "PLN",
"amount": "100.0000",
"feeAmount": "1.5000",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"parentCode": "m9cqbfhk5x4e",
"metadata": null,
"createdAt": "2020-09-18 17:07:53",
"updatedAt": "2020-09-18 17:07:53"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/split/item/gmats9v3"
}
}
Usługa pozwalająca na przyjęcie jednej lub więcej wpłat od płatników (lub płatnika), które następnie są agregowane i przekazywane w trybie dziennym na wskazane konto odbiorcy. Aplikacja korzystająca z API może założyć zlecenie, a następnie otrzymywać potwierdzenia o opłaceniu każdej ze zdefiniowanej w ramach zlecenia płatności.
Tworzy zlecenie, które zbiera wpłaty na konto podane w body żądania API.
Parametr | Wymagane | Opis |
---|---|---|
currency | tak | waluta przelewu (aktualnie wspierane tylko PLN) |
toName | tak | nazwa odbiorcy |
toIban | tak | IBAN odbiorcy |
metadata | nie | opcjonalne dane przekazywane przez FiberPay w odpowiedzi, |
Przykładowa odpowiedź:
{
"data": {
"code": "w3taegy6fzuj",
"status": "open",
"type": "collect",
"currency": "PLN",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"metadata": null,
"createdAt": "2020-09-18 17:11:46",
"updatedAt": "2020-09-18 17:11:46"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/collect/w3taegy6fzuj"
}
}
Tworzy pojedyncze zlecenie wpłaty środków za pomocą przelewu. Środki przelane w ramach tego zlecenia trafiają później w agregacji dziennej na konto odbiorcy klienta podane w zleceniu nadrzędnym collect. W przypadku podania callbackUrl w ciele żądania, system wyśle na podany URL informacje o przeprowadzonej wpłacie, gdy taka nastąpi.
Parametr | Wymagane | Opis |
---|---|---|
amount | tak | kwota przelewu |
currency | tak | waluta przelewu (aktualnie wspierane tylko PLN) |
parentCode | tak | kod zlecenia nadrzędnego |
description | tak | tytuł przelewu |
metadata | nie | dane przekazywane przez FiberPay w odpowiedzi |
callbackUrl | nie | URL na który ma być wywołany callback |
callbackParams | nie | parametry callbacka |
redirectUrl | nie | URL, na który użytkownik zostanie przekierowany po dokonaniu płatności |
Przykładowa odpowiedź:
{
"data": {
"code": "xwbmedu9",
"status": "open",
"type": "collect_item",
"currency": "PLN",
"amount": "100",
"feeAmount": "0.50",
"toName": "Michał",
"parentCode": "p4rtzey3hnwv",
"description": "testowy przelew",
"metadata": null,
"createdAt": "2020-09-18 17:13:42",
"updatedAt": "2020-09-18 17:13:42",
"redirect": "https://test.fiberpay.pl/order/xwbmedu9"
},
"invoice": {
"amount": "100.50",
"currency": "PLN",
"iban": "PL123400001",
"bban": "123400001",
"description": "xwbmedu9"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/collect/item/xwbmedu9"
}
}
Pobranie informacji o całym zleceniu
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod zlecenia |
Przykładowa odpowiedź serwera:
{
"data": {
"code": "w3taegy6fzuj",
"status": "open",
"type": "collect",
"currency": "PLN",
"toName": "Michał",
"toIban": "PL27114020040000300201355387",
"metadata": null,
"createdAt": "2020-09-18 17:11:46",
"updatedAt": "2020-09-18 17:11:46"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/collect/w3taegy6fzuj"
}
}
Przykładowa odpowiedź serwera:
{
"data": {
"code": "xwbmedu9",
"status": "open",
"type": "collect_item",
"currency": "PLN",
"amount": "100",
"feeAmount": "0.50",
"toName": "Michał",
"parentCode": "p4rtzey3hnwv",
"description": "testowy przelew",
"metadata": null,
"createdAt": "2020-09-18 17:13:42",
"updatedAt": "2020-09-18 17:13:42",
"redirect": "https://test.fiberpay.pl/order/xwbmedu9"
},
"invoice": {
"amount": "100.50",
"currency": "PLN",
"iban": "PL123400001",
"bban": "123400001",
"description": "xwbmedu9"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/collect/item/xwbmedu9"
}
}
Pobranie informacji o pojedynczej wpłacie
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod zlecenia |
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod zlecenia |
Przykładowa odpowiedź:
{
"data": {
"code": "xwbmedu9",
"status": "cancelled",
"type": "collect_item",
"currency": "PLN",
"amount": "100.0000",
"feeAmount": "0.5000",
"toName": "Michał",
"parentCode": "p4rtzey3hnwv",
"description": "testowy przelew",
"metadata": null,
"createdAt": "2020-09-18 17:13:42",
"updatedAt": "2020-09-18 17:25:46",
"redirect": "https://test.fiberpay.pl/order/xwbmedu9"
},
"invoice": [],
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/collect/item/xwbmedu9"
}
}
Usługa dwóch powiązanych przekazów pieniężnych, pozwalająca na przyjęcie przekazu pieniężnego, a następnie opłacenie innego przekazu ze środków pierwszego.
- Source - osoba opłacająca przekaz
- Target - odbiorca przekazu
- Broker - pośrednik obsługujący osobę opłacającą oraz odbiorcę przekazu
Utworzenie zlecenia. Parametry żądania:
Parametr | Wymagane | Opis |
---|---|---|
sourceAmount | tak | całościowa kwota przekazu, decimal z maks. 2 miejscami po przecinku (np. 100.50) |
targetAmount | tak | kwota przekazu, która trafi do odbiorcy, decimal z maks. 2 miejscami po przecinku (np. 100.50) |
currency | tak | waluta, aktualnie dostępne tylko PLN |
targetName | tak | nazwa odbiorcy |
targetIban | tak | IBAN odbiorcy |
brokerName | tak | nazwa pośrednika |
brokerIban | tak | IBAN pośrednika |
description | nie | tytuł przelewu |
targetDescription | tak | opis dla odbiorcy |
beforePaymentInfo | nie | dodatkowy komunikat wyświetlany przed płatnością |
afterPaymentInfo | nie | dodatkowy komunikat wyświetlany po płatności |
metadata | nie | opcjonalne dane przekazywane przez FiberPay w callbacku |
callbackUrl | nie | URL na który ma być wywołany callback |
callbackParams | nie | opcjonalne parametry callbacka |
Przykładowa odpowiedź serwera:
{
"data": {
"code": "xbwucsgfn5pa",
"status": "defined",
"type": "forward",
"currency": "PLN",
"targetAmount": "100.0000",
"targetName": "Target",
"targetIban": "PL12340000TARGET",
"targetDescription": "targetDescription",
"brokerAmount": "48.7500",
"brokerName": "Broker",
"brokerIban": "PL12340000BROKER",
"feeAmount": "1.2500",
"createdAt": "2020-09-16 18:43:37",
"updatedAt": "2020-09-16 18:43:37"
},
"invoice": {
"amount": "150.00",
"currency": "PLN",
"iban": "PL123400005",
"description": "n9t6k4zw"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/forward/xbwucsgfn5pa"
}
}
Parametr | Wymagane | Opis |
---|---|---|
code | tak | kod zlecenia |
Przykładowa odpowiedź serwera:
{
"data": {
"code": "xbwucsgfn5pa",
"status": "defined",
"type": "forward",
"currency": "PLN",
"targetAmount": "100.0000",
"targetName": "Target",
"targetIban": "PL12340000TARGET",
"targetDescription": "targetDescription",
"brokerAmount": "48.7500",
"brokerName": "Broker",
"brokerIban": "PL12340000BROKER",
"feeAmount": "1.2500",
"createdAt": "2020-09-16 18:43:37",
"updatedAt": "2020-09-16 18:43:37"
},
"invoice": {
"amount": "150.00",
"currency": "PLN",
"iban": "PL123400005",
"description": "n9t6k4zw"
},
"links": {
"rel": "self",
"href": "https://apitest.fiberpay.pl/1.0/orders/forward/xbwucsgfn5pa"
}
}
Jest to rozszerzenie zlecenia typu collect_item, które posiada dodatkowe możliwości związane z terminem opłacenia zlecenia. Dodatkowe ustawienia:
- Ustawienie terminu możliwości opłacenia zlecenia.
Opcjonalnie:
- Podanie danych osoby, która opłaca zlecenie.
- Dodanie systemu przypomnień mailowych.
- Utworzenie płatności cyklicznej.
- Dodanie tagu.
Rozszerzenie istniejącego zlecenia collect do wersji extended.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod podmiotu zlecenia collect |
term | tak | Opis zlecenia |
description | nie | Własny opis |
renewal | nie | Zlecenie cykliczne |
Parametry obiektu zlecenia cyklicznego.
Parametr | Wymagane | Opis | Możliwości |
---|---|---|---|
startsAt | tak | Data startu | |
intervalAmount | tak | Okres powtórzeń | |
intervalType | tak | Typ powtórzeń | day,week,month |
endType | tak | Typ zakończenia | count,date,none |
ordersCountLimit | endType=count | Limit powtórzeń | |
endsAt | endType=date | Data zakończenia |
{
"data": {
"code": "jntxvp5z",
"status": "open",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "addition"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "100.00",
"description": "Salary payment",
"title": "Salary payment",
"term": "2023-02-10",
"paymentUrl": "https://pay.fiberpay.pl/order/jntxvp5z",
"toName": "Marian Nowak",
"createdAt": "2023-01-31"
},
"partnerAccount": "PL89124031741111001032180939",
"debtor": null,
"notificationsPlan": null,
"orderRenewal": null,
"tags": []
}
Pobranie informacji o zleceniach typu extended
{
"data": [
{
"data": {
"code": "8tcsx36e",
"status": "received",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "test",
"title": "test",
"term": "2023-01-30",
"paymentUrl": "https://pay.fiberpay.pl/order/8tcsx36e",
"toName": "Marian Nowak",
"createdAt": "2022-12-22"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": {
"code": "m6ht7ywqbksu",
"type": "unknown",
"email": "test@inpay.pl",
"phone_prefix": "+48",
"phone_number": "123123124",
"name": "Michal Kowalski",
"first_name": "Michal",
"last_name": "Kowalski",
"nip": null,
"fullNameAndEmail": "Michal Kowalski | test@inpay.pl"
},
"notificationsPlan": {
"status": "in_progress",
"type": "hades",
"completedAt": null,
"plan": []
},
"orderRenewal": null,
"tags": [
{
"name": "Test",
"color": "red"
}
]
}
]
}
Pobranie informacji o pojedynczym zleceniu
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia |
{
"data": {
"code": "8tcsx36e",
"status": "received",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "test",
"title": "test",
"term": "2023-01-30",
"paymentUrl": "https://pay.fiberpay.pl/order/8tcsx36e",
"toName": "Marian Nowak",
"createdAt": "2022-12-22"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": {
"code": "m6ht7ywqbksu",
"type": "unknown",
"email": "test@inpay.pl",
"phone_prefix": "+48",
"phone_number": "123123124",
"name": "Michal Kowalski",
"first_name": "Michal",
"last_name": "Kowalski",
"nip": null,
"fullNameAndEmail": "Michal Kowalski | test@inpay.pl"
},
"notificationsPlan": {
"status": "in_progress",
"type": "hades",
"completedAt": null,
"plan": []
},
"orderRenewal": null,
"tags": [
{
"name": "Test",
"color": "red"
}
]
}
Utworzenie zlecenia typu extended. Konto docelowe zlecenia to domyślnie ustawione konto użytkownika na stronie zapłatomat.pl.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia |
amount | tak | Kwota |
currency | tak | Waluta |
title | tak | Tytuł płatności |
term | tak | Opis zlecenia |
description | nie | Własny opis |
renewal | nie | Zlecenie cykliczne |
Parametry obiektu zlecenia cyklicznego
Parametr | Wymagane | Opis | Możliwości |
---|---|---|---|
startsAt | tak | Data startu | |
intervalAmount | tak | Okres powtórzeń | |
intervalType | tak | Typ powtórzeń | day,week,month |
endType | tak | Typ zakończenia | count,date,none |
ordersCountLimit | endType=count | Limit powtórzeń | |
endsAt | endType=date | Data zakończenia |
{
"data": {
"code": "nub5rcyj",
"status": "open",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "description",
"title": "title",
"term": "2023-01-20",
"paymentUrl": "https://pay.fiberpay.pl/order/nub5rcyj",
"toName": "Marian Nowak",
"createdAt": "2023-02-08"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": null,
"notificationsPlan": null,
"orderRenewal": {
"code": "36wtcdafvkb2",
"status": "active",
"intervalAmount": 3,
"intervalType": "day",
"ordersCountLimit": 2,
"endsAt": null,
"startsAt": "2023-02-28",
"nextRenewalAt": "2023-02-28",
"updatedAt": "2023-02-08",
"createdAt": "2023-02-08"
},
"tags": []
}
Aktualizacja zlecenia typu extended.
Parametr | Wymagane | Opis | Możliwości |
---|---|---|---|
code | tak | Kod zlecenia | |
description | nie | Własny opis | |
updateRenewed | nie | Aktualizacja zleceń cyklicznych | no,following,all |
{
"data": {
"code": "nub5rcyj",
"status": "open",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "test2",
"title": "title",
"term": "2023-02-08",
"paymentUrl": "https://pay.fiberpay.pl/order/nub5rcyj",
"toName": "Marian Nowak",
"createdAt": "2023-02-08"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": null,
"notificationsPlan": null,
"orderRenewal": {
"code": "36wtcdafvkb2",
"status": "active",
"intervalAmount": 3,
"intervalType": "day",
"ordersCountLimit": 2,
"endsAt": null,
"startsAt": "2023-02-28",
"nextRenewalAt": "2023-02-28",
"updatedAt": "2023-02-08",
"createdAt": "2023-02-08"
},
"tags": []
}
Usunięcie zlecenia typu extended.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia |
{
"data": {
"code": "nub5rcyj",
"status": "cancelled",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "test2",
"title": "title",
"term": "2023-02-08",
"paymentUrl": "https://pay.fiberpay.pl/order/nub5rcyj",
"toName": "Marian Nowak",
"createdAt": "2023-02-08"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": null,
"notificationsPlan": null,
"orderRenewal": {
"code": "36wtcdafvkb2",
"status": "active",
"intervalAmount": 3,
"intervalType": "day",
"ordersCountLimit": 2,
"endsAt": null,
"startsAt": "2023-02-28",
"nextRenewalAt": "2023-02-28",
"updatedAt": "2023-02-08",
"createdAt": "2023-02-08"
},
"tags": []
}
Aktualizacja płatnika dla zlecenia typu extended.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia |
payerCode | tak | Kod płatnika |
{
"data": {
"code": "nub5rcyj",
"status": "cancelled",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "test2",
"title": "title",
"term": "2023-02-08",
"paymentUrl": "https://pay.fiberpay.pl/order/nub5rcyj",
"toName": "Marian Nowak",
"createdAt": "2023-02-08"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": {
"code": "p6sy78g9f3rq",
"type": "unknown",
"email": "test@inpay.pl",
"phone_prefix": "+48",
"phone_number": "123123123",
"name": "MICHAŁ KOWALSKI",
"first_name": "MICHAŁ",
"last_name": "KOWALSKI",
"nip": null,
"fullNameAndEmail": "MICHAŁ KOWALSKI | test@inpay.pl"
},
"notificationsPlan": null,
"orderRenewal": {
"code": "36wtcdafvkb2",
"status": "active",
"intervalAmount": 3,
"intervalType": "day",
"ordersCountLimit": 2,
"endsAt": null,
"startsAt": "2023-02-28",
"nextRenewalAt": "2023-02-28",
"updatedAt": "2023-02-08",
"createdAt": "2023-02-08"
},
"tags": []
}
Aktualizacja tagów dla zlecenia typu extended.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia |
tags | tak | Tablica tagów |
{
"data": {
"code": "nub5rcyj",
"status": "cancelled",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "test2",
"title": "title",
"term": "2023-02-08",
"paymentUrl": "https://pay.fiberpay.pl/order/nub5rcyj",
"toName": "Marian Nowak",
"createdAt": "2023-02-08"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": {
"code": "p6sy78g9f3rq",
"type": "unknown",
"email": "test@inpay.pl",
"phone_prefix": "+48",
"phone_number": "123123123",
"name": "MICHAŁ KOWALSKI",
"first_name": "MICHAŁ",
"last_name": "KOWALSKI",
"nip": null,
"fullNameAndEmail": "MICHAŁ KOWALSKI | test@inpay.pl"
},
"notificationsPlan": null,
"orderRenewal": {
"code": "36wtcdafvkb2",
"status": "active",
"intervalAmount": 3,
"intervalType": "day",
"ordersCountLimit": 2,
"endsAt": null,
"startsAt": "2023-02-28",
"nextRenewalAt": "2023-02-28",
"updatedAt": "2023-02-08",
"createdAt": "2023-02-08"
},
"tags": [
{
"name": "Test3",
"color": "red"
}
]
}
Pobranie propozycji planu dla zlecenia.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia |
{
"data": {
"ab_hds_04": {
"message": "Przypomnienie w dniu płatności",
"value": 0,
"type": "notification",
"severity": "midHigh",
"enabled": true
},
"ab_hds_05": {
"message": "Wezwanie do zapłaty (3 dni po terminie)",
"value": -3,
"type": "summons",
"severity": "high",
"enabled": true
}
}
}
Dodanie planu dla zlecenia.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia |
plan | tak | Tablica planu |
{
"data": {
"code": "8tcsx36e",
"status": "received",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "test",
"title": "test",
"term": "2023-01-30",
"paymentUrl": "https://pay.fiberpay.pl/order/8tcsx36e",
"toName": "Marian Nowak",
"createdAt": "2022-12-22"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": {
"code": "m6ht7ywqbksu",
"type": "unknown",
"email": "konrad.ogniewski@inpay.pl",
"phone_prefix": "+48",
"phone_number": "123123124",
"name": "TEN",
"first_name": "MICHAŁ",
"last_name": "KOWALSKI",
"nip": null,
"fullNameAndEmail": "MICHAŁ KOWALSKI| test@inpay.pl"
},
"notificationsPlan": {
"status": "in_progress",
"type": "hades",
"completedAt": null,
"plan": []
},
"orderRenewal": null,
"tags": [
{
"name": "Test3",
"color": "red"
}
]
}
Pobranie historii zlecenia.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia |
{
"data": [
{
"code": "nrpzk2chefdt",
"message": "Zlecenie #nub5rcyj zostało anulowane.",
"type": "order_cancelled",
"params": {
"orderCode": "nub5rcyj"
},
"createdAt": "2023-02-08 15:04"
},
{
"code": "rxzs9tj672f4",
"message": "Zlecenie #nub5rcyj zostało utworzone. Termin płatności - 2023-01-20",
"type": "order_created",
"params": {
"orderCode": "nub5rcyj",
"amount": 100,
"currency": "PLN",
"paymentDeadline": "2023-01-20"
},
"createdAt": "2023-02-08 14:57"
}
],
}
Ścieżki dotyczące informacji o płatniku.
Pobranie listy zapisanych płatników.
{
"data": [
{
"code": "p6sy78g9f3rq",
"type": "unknown",
"email": "test@inpay.pl",
"firstName": "MICHAŁ",
"lastName": "KOWALSKI",
"name": "MICHAŁ KOWALSKI",
"phonePrefix": "+48",
"phoneNumber": "123123123",
"nip": null,
"createdAt": "2023-02-08 15:12:30",
"updatedAt": "2023-02-08 15:12:30"
}
]
}
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod płatnika |
{
"data": {
"code": "p6sy78g9f3rq",
"type": null,
"email": "test@inpay.pl",
"firstName": "MICHAŁ",
"lastName": "KOWALSKI",
"name": "MICHAŁ KOWALSKI",
"phonePrefix": "+48",
"phoneNumber": "123123123",
"nip": null,
"createdAt": "2023-02-08 15:12:30",
"updatedAt": "2023-02-08 15:12:30"
}
}
Utworzenie płatnika.
Parametr | Wymagane | Opis | Możliwości |
---|---|---|---|
tak | |||
phoneNumber | nie | Numer telefonu | |
phonePrefix | nie | Prefix numeru | |
firstName | nie | Typ zakończenia | |
lastName | nie | Typ zakończenia | |
name | nie | Typ zakończenia | |
type | nie | Limit powtórzeń | unknown,company,personal |
{
"data": {
"code": "p6sy78g9f3rq",
"type": null,
"email": "test@inpay.pl",
"firstName": "MICHAŁ",
"lastName": "KOWALSKI",
"name": "MICHAŁ KOWALSKI",
"phonePrefix": "+48",
"phoneNumber": "123123123",
"nip": null,
"createdAt": "2023-02-08 15:12:30",
"updatedAt": "2023-02-08 15:12:30"
}
}
Aktualizacja danych płatnika.
Parametr | Wymagane | Opis | Możliwości |
---|---|---|---|
code | tak | Kod płatnika | |
tak | |||
phoneNumber | nie | Numer telefonu | |
phonePrefix | nie | Prefix numeru | |
firstName | nie | Typ zakończenia | |
lastName | nie | Typ zakończenia | |
name | nie | Typ zakończenia | |
type | nie | Limit powtórzeń | unknown,company,personal |
{
"data": {
"code": "p6sy78g9f3rq",
"type": null,
"email": "test@inpay.pl",
"firstName": "MICHAŁ",
"lastName": "KOWALSKI",
"name": "MICHAŁ KOWALSKI",
"phonePrefix": "+48",
"phoneNumber": "123123123",
"nip": null,
"createdAt": "2023-02-08 15:12:30",
"updatedAt": "2023-02-08 15:12:30"
}
}
Pobranie zleceń przypisanych do danego płatnika.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod płatnika |
{
"data": [
{
"data": {
"code": "nub5rcyj",
"status": "cancelled",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "test2",
"title": "title",
"term": "2023-02-08",
"paymentUrl": "https://pay.fiberpay.pl/order/nub5rcyj",
"toName": "Marian Nowak",
"createdAt": "2023-02-08"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": {
"code": "p6sy78g9f3rq",
"type": "unknown",
"email": "test@inpay.pl",
"phone_prefix": "+48",
"phone_number": "123123123",
"name": "MICHAŁ KOWALSKI",
"first_name": "MICHAŁ",
"last_name": "KOWALSKI",
"nip": null,
"fullNameAndEmail": "MICHAŁ KOWALSKI | test@inpay.pl"
},
"notificationsPlan": null,
"orderRenewal": {
"code": "36wtcdafvkb2",
"status": "active",
"intervalAmount": 3,
"intervalType": "day",
"ordersCountLimit": 2,
"endsAt": null,
"startsAt": "2023-02-28",
"nextRenewalAt": "2023-02-28",
"updatedAt": "2023-02-08",
"createdAt": "2023-02-08"
},
"tags": []
}
],
}
Pobieranie wcześniej utworzonych tagów.
[
{
"name": "Test",
"color": "red"
}
]
Pobieranie wcześniej utworzonego taga
Parametr | Wymagane | Opis |
---|---|---|
name | tak | Nazwa |
[
{
"name": "Test",
"color": "red"
}
]
Tworzenie tagów.
Parametr | Wymagane | Opis | Możliwości |
---|---|---|---|
name | tak | Nazwa | |
color | tak | Kolor | Paleta bazowych kolorów |
{
"name": "Test5",
"color": "grey"
}
Usuwanie tagu.
Parametr | Wymagane | Opis |
---|---|---|
name | tak | Nazwa |
{
"name": "Test5",
"color": "grey"
}
Zlecenia cykliczne.
Pobranie zlecenia cyklicznego.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia cyklicznego |
"data": {
"code": "zgmt593xjp6d",
"status": "active",
"intervalAmount": 3,
"intervalType": "day",
"ordersCountLimit": 2,
"endsAt": null,
"startsAt": "2023-01-30",
"nextRenewalAt": "2023-02-02",
"updatedAt": "2023-01-31",
"createdAt": "2023-01-31"
}
}
Anulowanie zlecenia cyklicznego.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia cyklicznego |
"data": {
"code": "zgmt593xjp6d",
"status": "active",
"intervalAmount": 3,
"intervalType": "day",
"ordersCountLimit": 2,
"endsAt": null,
"startsAt": "2023-01-30",
"nextRenewalAt": "2023-02-02",
"updatedAt": "2023-01-31",
"createdAt": "2023-01-31"
}
}
Pobranie zleceń dla zlecenia cyklicznego.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia cyklicznego |
{
"data": [
{
"data": {
"code": "b8dszgjv",
"status": "open",
"amount": "100.00",
"currency": "PLN",
"fees": [
{
"amount": "2.00",
"currency": "PLN",
"type": "subtraction"
}
],
"totalFeeAmount": "2.00",
"receiverAmount": "98.00",
"description": "description",
"title": "title",
"term": "2023-01-31",
"paymentUrl": "https://pay.fiberpay.pl/order/b8dszgjv",
"toName": "Marian Nowak",
"createdAt": "2023-01-31"
},
"partnerAccount": "PL61109010140000071219812874",
"debtor": null,
"notificationsPlan": null,
"orderRenewal": {
"code": "zgmt593xjp6d",
"status": "active",
"intervalAmount": 3,
"intervalType": "day",
"ordersCountLimit": 2,
"endsAt": null,
"startsAt": "2023-01-30",
"nextRenewalAt": "2023-02-02",
"updatedAt": "2023-01-31",
"createdAt": "2023-01-31"
},
"tags": []
}
]
}
Pobranie planu cyklu dla zlecenia cyklicznego.
Parametr | Wymagane | Opis |
---|---|---|
code | tak | Kod zlecenia cyklicznego |
{
"2023-02": [
{
"amount": "100.0000",
"currency": "PLN",
"title": "title",
"description": "description",
"term": "2023-02-01T23:00:00.000000Z",
"renewal_code": "zgmt593xjp6d",
"scheduled_at": "2023-02-01T23:00:00.000000Z",
"payer": null
}
]
}
Pobranie cykli dla wszystkich zleceń cyklicznych.
{
"2023-02": [
{
"amount": "100.0000",
"currency": "PLN",
"title": "title",
"description": "description",
"term": "2023-02-01T23:00:00.000000Z",
"renewal_code": "zgmt593xjp6d",
"scheduled_at": "2023-02-01T23:00:00.000000Z",
"payer": null
},
{
"amount": "100.0000",
"currency": "PLN",
"title": "title",
"description": "test2",
"term": "2023-02-27T23:00:00.000000Z",
"renewal_code": "36wtcdafvkb2",
"scheduled_at": "2023-02-27T23:00:00.000000Z",
"payer": {
"code": "p6sy78g9f3rq",
"type": "unknown",
"email": "test@inpay.pl",
"phone_prefix": "+48",
"phone_number": "123123123",
"name": "MICHAŁ KOWALSKI",
"first_name": "MICHAŁ",
"last_name": "KOWALSKI",
"nip": null,
"fullNameAndEmail": "MICHAŁ KOWALSKI | test@inpay.pl"
}
}
]
}