Skocz do: nawigacja, szukaj

Dokumentacja API SOAP


Konfiguracja

Uruchomienie

Aby uruchomić usługę należy:

  1. Wysłać Twój adres IP (adres serwera) na adres service@przelewy24.pl
  2. Uzyskać klucz dostępu z Przelewy24

Adresy serwera


gdzie SHOPID - jest identyfikatorem Sprzedawcy uzyskanym w procesie rejestracji

Srodowisko testowe


gdzie SHOPID - jest identyfikatorem Sprzedawcy uzyskanym w procesie rejestracji

Metody

TestAccess

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$test = $soap->TestAccess("9999", "anuniquekeyretrievedfromprzelewy24");
if ($test)
 echo 'Access granted';
else
 echo 'Access denied';
?>

Metoda sprawdza poprawność połączenia z serwerem.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
Parametry wyjściowe
typ opis
bool true – w przypadku poprawnych danych, false – w przeciwnym przypadku

GetTransactionBySessionId

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$res = $soap->GetTransactionBySessionId
 ('9999', 'anuniquekeyfromp24', 'f3958fjsxndri');
// $res->result contains data about transaction, or object with empty
field in case of error
if ($res->error->errorCode) {
 echo 'Something went wrong: ' . $res->error->errorMessage;
} else {
 echo 'Transaction: ';
 $transaction = $res->result;
 // data of transaction: $transaction->orderId, $transaction->amount,
$transaction->date
}
?>

Metoda zwraca informacje o transakcji na podstawie pola SessionId.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
sessionId string SessionID transakcji
Parametry wyjściowe
nazwa typ
result Transaction
error GeneralError


Powiązane typy danych
Transaction
Obiekt pojedynczej transakcji.
dostępne pola typ opis
orderId int identyfikator transakcji
sessionId string sesja transakcji
status int 0 – brak wpłaty, 1 – przedpłata, 2 – dokonana, 3 – zwrócona
amount int kwota wpłaty
currency string
date string YYYYMMDDHHMM
dateOfTransaction string
clientEmail string
accountMD5 string
paymentMethod int
description string
clientAddress string
clientCity string
clientName string
clientPostcode string
batchId int ID paczki, w której transakcja została przekazana na rachunek bankowy Sprzedawcy. Jeżeli transakcja nie została jeszcze przypisana do paczki pojawi się wartość 0
fee int
statement string Informacja o tytule przelewu przedstawionym klientowi w procesie płatności
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

GetTransactionsByDate

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl"); 
$res = $soap->GetTransactionsByDate
 ('9999', 'anuniquekeyretrievedfromp24', '20110610');
// $res->result contains data about transactions, or object with empty
field in case of error
if ($res->error->errorCode) {
 echo 'Something went wrong: ' . $res->error->errorMessage;
} else {
 echo 'Transaction: ';
 $LIST = $res->result;
 foreach ($LIST as $transaction) {
 // data of transaction: $transaction->orderId, $transaction->amount,
$transaction->date
 // ...
 }
}
?>

Metoda zwraca listę transakcji w zadanym dniu.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
date string Data w formacie: YYYYMMDD
Parametry wyjściowe
nazwa typ
result array of Transaction
error GeneralError


Powiązane typy danych
Transaction
Obiekt pojedynczej transakcji.
dostępne pola typ opis
orderId int identyfikator transakcji
sessionId string sesja transakcji
status int 0 – brak wpłaty, 1 – przedpłata, 2 – dokonana, 3 – zwrócona
amount int kwota wpłaty
currency string
date string YYYYMMDDHHMM
dateOfTransaction string
clientEmail string
accountMD5 string
paymentMethod int
description string
clientAddress string
clientCity string
clientName string
clientPostcode string
batchId int ID paczki, w której transakcja została przekazana na rachunek bankowy Sprzedawcy. Jeżeli transakcja nie została jeszcze przypisana do paczki pojawi się wartość 0
fee int
statement string Informacja o tytule przelewu przedstawionym klientowi w procesie płatności
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

GetTransactionsByBatch

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$res = $soap->GetTransactionsByBatch
 ('9999', 'anuniquekeyretrievedfromp24', '123456');
// $res->result contains data about transactions, or object with empty field in case of error 
if ($res->error->errorCode) {
 echo 'Something went wrong: ' . $res->error->errorMessage;
} else {
 echo 'Transaction: ';
 $LIST = $res->result;
 foreach ($LIST as $transaction) {
 // data of transaction: $transaction->orderId, $transaction-
>amount, $transaction->date
 // ...
 }
}
?>

Metoda zwraca listę transakcji przekazanych w zadanej paczce (przelewie).

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
batch int Unikalny indetyfikator paczki
Parametry wyjściowe
nazwa typ
result array of Transaction
error GeneralError


Powiązane typy danych
Transaction
Obiekt pojedynczej transakcji.
dostępne pola typ opis
orderId int identyfikator transakcji
sessionId string sesja transakcji
status int 0 – brak wpłaty, 1 – przedpłata, 2 – dokonana, 3 – zwrócona
amount int kwota wpłaty
currency string
date string YYYYMMDDHHMM
dateOfTransaction string
clientEmail string
accountMD5 string
paymentMethod int
description string
clientAddress string
clientCity string
clientName string
clientPostcode string
batchId int ID paczki, w której transakcja została przekazana na rachunek bankowy Sprzedawcy. Jeżeli transakcja nie została jeszcze przypisana do paczki pojawi się wartość 0
fee int
statement string Informacja o tytule przelewu przedstawionym klientowi w procesie płatności
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

PaymentMethods

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$res = $soap->PaymentMethods('9999', 'anuniquekeyretrievedfromprzelewy24', 'en');
// $res->result contains data about payment methods
if ($res->error->errorCode) {
 echo 'Something went wrong: ' . $res->error->errorMessage;
} else {
 echo 'Payment methods: ';
 $LIST = $res->result;
foreach ($LIST as $pm) {
 // data of payment method: $pm->name, $pm->id, $pm->status
 // ...
 }
}
?>

Metoda zwraca listę dostępnych metod płatności

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
lang string(2) Język, jedna z dwóch wartości: “pl” , “en”


Parametry wyjściowe
nazwa typ
result array of PaymentMethod
error GeneralError


Powiązane typy danych
PaymentMethod
Obiekt pojedynczej metody płatności
dostępne pola typ opis
name string
id int
status bool
avaibilityHours
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

CurrencyExchange

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$res = $soap-> CurrencyExchange('9999', 'anuniquekeyretrievedfromprzelewy24');
// $res->result contains data about rates
if ($res->error->errorCode) {
 echo 'Something went wrong: ' . $res->error->errorMessage;
} else {
 echo 'Exchange rates: ';
 $LIST = $res->result;
 foreach ($LIST as $rate) {
 // data: $rate->code, $rate->exchng
 }
}
?>

Metoda zwraca listę dostępnych metod płatności

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24


Parametry wyjściowe
nazwa typ
result array of CurrencyExchange
error GeneralError


Powiązane typy danych
CurrencyExchange
Obiekt pojedynczej waluty.
dostępne pola typ opis
code string
exchng float
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

VerifyTransaction

Alternatywa dla funkcji trnVerify, służy do weryfikacji wyniku transakcji.

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$res = $soap-> VerifyTransaction('9999', 'keyfromprzelewy24', 123456, 'abcdef', 1000);
if ($res->error->errorCode) {
 echo 'Something went wrong: ' . $res->error->errorMessage;
} else {
 echo 'Transaction OK';
}
?>
Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
orderId int Numer transakcji nadany przez Przelewy24
sessionId string Session ID
amount int Kwota wyrażona w danej walucie, w setnej części (1/100 waluty podstawowej)
currency string Waluta: PLN / EUR / CHF / USD / GBP (default: PLN)
Parametry wyjściowe
nazwa typ opis
result bool true jeżeli transakcja jest poprawna, w przeciwnym wypadku false
error GeneralError


Powiązane typy danych
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

RefundTransaction

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$refunds = array(
 0=> array(
 'sessionId' => 'na39asdfghvb54f5g6y7lrjc0',
 'orderId' => 38919018,
 'amount' => 9000
 ),
 1=>array(
 'sessionId' => 'fff46yugr9037d92b54tg60e77',
 'orderId' => 42819179,
 'amount' => 2000
 )
); 
$res = $soap->RefundTransaction('9999', 'anuniquekeyretrievedfromp24', time(), $refunds);
if ($res->error->errorCode > 0) {
// something went wrong
 echo 'An error occurred: ' . $res->error->errorMessage;
 foreach ($res->result as $refund) {
 if ($refund->status)
 echo 'Transaction: ' . $refund->orderId . ' - OK.';
 else
 echo 'Transaction: ' . $refund->orderId . ' - ERROR: ' . $refund-
>error;
 }
} else {
 echo 'Refunds accepted.';
}
?>

Metoda do zlecania zwrotów do transakcji. Kwota transakcji może być mniejsza lub równa kwocie transakcji. Można zlecić wiele zwrotów do jednej transakcji, ale suma zwrotów nie może przekroczyć wartości danej trasnakcji.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
requestId int Unikalny indentyfikator żądania
list ArrayOfRefund Lista transakcji do zwrotu
Typ danych
nazwa opis
ArrayOfRefund Tablica informacji (tablic) o pojedynczych zwrotach, z polami: orderId (int), sessionId (string), amount (int)
Parametry wyjściowe
nazwa typ
result array of SingleRefund
error GeneralError


Powiązane typy danych
SingleRefund
Objekt pojedynczego zwrotu.
dostępne pola typ opis
orderId int
sessionId string
status bool
error string Zawiera informację odnośnie błędu dla danego pojedynczego zwrotu.
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

GetRefundInfo

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$res = $soap->GetRefundInfo('9999', 'anuniquekeyretrievedfromp24', 38919018);
if ($res->error->errorCode > 0) { 
// something went wrong
 echo 'An error occurred: ' . $res->error->errorMessage;
} else {
 foreach ($res->result as $refund) {
 echo 'Status: ' . $refund->statusTxt;
 }
}
?>

Metoda zwraca informacje o zleconym zwrocie.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
orderId int Numer transakcji nadany przez Przelewy24
Parametry wyjściowe
nazwa typ
result array of RefundInfo
error GeneralError


Powiązane typy danych
RefundInfo
Obiekt z informacją o pojedynczym zwrocie.
dostępne pola typ opis
orderId int
sessionId string
batchId int
requestId int
date string format YYMMDDHHIISS
status int
statusTxt string
amount int
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

GetTransactionReference

Metoda zwraca informację na temat danej karty płatniczej.

<?php
$soap = new SoapClient('https://secure.przelewy24.pl/external/wsdl/charge_card_service.php?wsdl');
$transactionReferenceResult = $soap->GetTransactionReference(12345, 'secretkey', 12345678);
if ($transactionReferenceResult->error->errorCode === 0) {
 $refId = $transactionReferenceResult->result->refId;
 $bin = $transactionReferenceResult->result->bin;
 $mask = $transactionReferenceResult->result->mask;
 $cardType = $transactionReferenceResult->result->cardType;
}
else {
 echo 'Error occurred '. $transactionReferenceResult->error->errorMessage;
}
?>
Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
orderId int Numer transakcji nadany przez Przelewy24
Parametry wyjściowe
nazwa typ
result TransactionReference
error GeneralError


Powiązane typy danych
TransactionReference
Obiekt z informacjami o karcie płatniczej.
dostępne pola typ opis
refId string Unikalny token (kod referencyjny) karty
bin int Numer BIN karty
mask string Maskowany numer karty
cardType string Typ karty (VISA, ECMC)
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string


ChargeCard

Metoda realizuje obciążenie karty na podstawie przekazanego tokena.

<?php
$soap = new SoapClient('https://secure.przelewy24.pl/external/wsdl/charge_card_service.php?wsdl');
$ChargeCardResult = $soap->ChargeCard(123456, 'secretkey', '1111111-22222222-33333333-abcdefgh', 100, 'PLN', 'test@email.com', 'uniqueSessionId', 'Tester', 'test payment');
if ($ChargeCardResult->error->errorCode === 0) {
 $orderId = $ChargeCardResult->result->orderId;
}
else {
 echo 'Error occurred '. $ChargeCardResult->error->errorMessage;
}
?>
Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
refid string Unikalny token (kod referencyjny) karty
amount int Kwota wyrażona w danej walucie, w setnej części (1/100 waluty podstawowej)
currency string Kod waluty (ISO4217)
email string Adres e-mail klienta
sessionId string Unikalny indentyfikator sesji
client string Imię i nazwisko klienta
description string Opis transakcji
Parametry wyjściowe
nazwa typ opis
result int Identyfikator utworzonej transakcji
error GeneralError


Powiązane typy danych
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

RecurringChargeCard

<?php
$soap = new SoapClient('https://secure.przelewy24.pl/external/wsdl/charge_card_service.php?wsdl');
$ChargeCardResult = $soap->RecurringChargeCard(123456, 'secretkey', '1111111-22222222-33333333-abcdefgh', 100, 'PLN', 'test@email.com', 'uniqueSessionId', 'Tester', 'test payment');
if ($ChargeCardResult->error->errorCode === 0) {
 $orderId = $ChargeCardResult->result->orderId;
}
else {
 echo 'Error occurred '. $ChargeCardResult->error->errorMessage;
}
?>

Metoda realizuje rekurencyjne obciążenie karty na podstawie przekazanego tokena.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
refid string Unikalny token (kod referencyjny) karty
amount int Kwota wyrażona w danej walucie, w setnej części (1/100 waluty podstawowej)
currency string Kod waluty (ISO4217)
email string Adres e-mail klienta
sessionId string Unikalny indentyfikator sesji
client string Imię i nazwisko klienta
description string Opis transakcji
Parametry wyjściowe
nazwa typ opis
result int Identyfikator utworzonej transakcji
error GeneralError


Powiązane typy danych
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

CheckCard

<?php
$soap = new SoapClient('https://secure.przelewy24.pl/external/wsdl/charge_card_service.php?wsdl');
$CheckCardResult = $soap->CheckCard(1234, 'secretkey', '1111111-22222222-33333333-abcdefgh');
if ($CheckCardResult->error->errorCode === 0) {
 $availability = $CheckCardResult->result;
}
else {
 echo 'Error occurred '. $CheckCardResult->error->errorMessage;
}
?>

Metoda zwraca informację, czy dana karta może być wykorzystana do płatności rekurencyjnych.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
refId string Unikalny token (kod referencyjny) karty
Parametry wyjściowe
nazwa typ opis
result bool Informacja czy dostępna jest opcja płatności rekurencyjnych i MOTO (true), czy nie (false)
error GeneralError


Powiązane typy danych
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

GetBatchDetails

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$res = $soap->GetBatchDetails('9999', 'anuniquekeyretrievedfromp24',
919018);
if ($res->error->errorCode > 0) {
// something went wrong
 echo 'An error occurred: ' . $res->error->errorMessage;
} else {
// data output
}
?>

Metoda zwraca informacje o szczegółach paczki, transakcje, zwroty i prowizje.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
batchId int Indetyfikator paczki
Parametry wyjściowe
nazwa typ
result BatchDetails
error GeneralError


Powiązane typy danych
BatchDetails
Obiekt z informacją o składzie paczki.
dostępne pola typ opis
transactions array of Transaction transakcje
refunds array of RefundInfo zwroty
charges int
Transaction
Obiekt pojedynczej transakcji.
dostępne pola typ opis
orderId int identyfikator transakcji
sessionId string sesja transakcji
status int 0 – brak wpłaty, 1 – przedpłata, 2 – dokonana, 3 – zwrócona
amount int kwota wpłaty
currency string
date string YYYYMMDDHHMM
dateOfTransaction string
clientEmail string
accountMD5 string
paymentMethod int
description string
clientAddress string
clientCity string
clientName string
clientPostcode string
batchId int ID paczki, w której transakcja została przekazana na rachunek bankowy Sprzedawcy. Jeżeli transakcja nie została jeszcze przypisana do paczki pojawi się wartość 0
fee int
statement string Informacja o tytule przelewu przedstawionym klientowi w procesie płatności
RefundInfo
Obiekt z informacją o pojedynczym zwrocie.
dostępne pola typ opis
orderId int
sessionId string
batchId int
requestId int
date string format YYMMDDHHIISS
status int
statusTxt string
amount int
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

RegisterOfflineTransaction

<?php
$soap = new SoapClient('https://secure.przelewy24.pl/external/999.wsdl', ['trace'=>1]);
$registerOfflineTransaction = $soap->RegisterOfflineTransaction (999, 'secretkey', [
 'amount' =>'1123',
 'email' =>'test@test.pl',
 'sessionId' =>'dskfjsdfksdfjskdfwevf',
 'methodId' =>'51',
 'client' =>'test',
 'street' =>'test',
 'city' =>'Poznan',
 'zip' =>'66-600',
 'country' =>'PL',
 'description' =>'Zamowienie' ]);
if ($registerOfflineTransaction->error->errorCode === 0) {
 $orderId = $registerOfflineTransaction->result->orderId;
}
else {
 echo 'Error occurred '. $registerOfflineTransaction->error->errorMessage;
}
?>

Metoda rejestruje transakcję i zwraca dane do przelewu.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
details TransactionDataIn Informacje o rejestrowanej transakcji
Parametry wyjściowe
nazwa typ
result RegisterOfflineTransactionResult
error GeneralError

Typy danych:

RegisterOfflineTransactionResult
Obiekt z identyfikatorem utworzonej transakcji oraz danymi do przelewu.
dostępne pola typ opis
orderId int identyfikator transakcji
statement string tytuł transakcji
session_id string sesja transakcji
ban string numer konta na który należy dokonać wpłaty
banOwner string nazwa odbiorcy wpłaty
banOwnerAddress string adres odbiorcy wpłaty
amount int kwota wpłaty
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

GetMerchantFunds

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$params = [
    "login" => 9999,
    "pass" => "anuniquekeyretrievedfromp24",
    "spid" => 9999
];
$res = $soap->__soapCall("GetMerchantFunds", $params);

if(!$res->error->errorCode)
    echo 'Saldo sprzedawcy 9999 (w gr): ' . $res->result;

Metoda służy do pobierania salda konta dla konkretnego merchanta (np. dla kont pasażowych).

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
spid string ID Sprzedawcy, którego dotyczy zapytanie
Parametry wyjściowe
nazwa typ opis
result int kwota wyrażona w setnej części (1/100 waluty podstawowej)
error GeneralError

Typy danych:

GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

GetRefundsByDate

<?php
$soap = new SoapClient("https://secure.przelewy24.pl/external/9999.wsdl");
$params = [
    "login" => 9999,
    "pass" => "anuniquekeyretrievedfromprzelewy24",
    "spid" => "20161228"
];
$res = $soap->__soapCall("GetRefundsByDate", $params);

if(!$res->error->errorCode) {
    foreach ($res->result as $refund) {
        echo 'Zwrot z transakcji ' . $refund->orderId . ' na kwotę (w gr) ' . $refund->amount . "\n";
    }
}

Metoda służy do pobierania informacji o zleconych zwrotach dla konkretnej daty.

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy
pass string Klucz do WS uzyskany z Przelewy24
date string Data w formacie YYYYMMDD
Parametry wyjściowe
nazwa typ
result array of RefundInfo
error GeneralError

Typy danych:

RefundInfo
Obiekt z informacją o pojedynczym zwrocie.
dostępne pola typ opis
orderId int
sessionId string
batchId int
requestId int
date string format YYMMDDHHIISS
status int
statusTxt string
amount int
GeneralError
Obiekt z informacją o błędach.
dostępne pola typ opis
errorCode int unikalny kod błędu
errorMessage string

RegisterTerminalCard

Parametry wejściowe
nazwa typ opis
login string ID Sprzedawcy.
pass string Klucz do WS uzyskany z Przelewy24.
clientID string ID klient z systemu sprzedawcy.
transactionID string ID transakcji
terminalID string ID terminala.
ccNumber string Numer karty płatniczej (tylko cyfry).
ccExp string Data ważności karty w formacie YYYY-MM-DD lub YYMM. Przykład: 2015-08-31, 1508
cvv string Kod weryfikacyjny karty.
Parametry wyjścia
nazwa typ opis
RegisteredTerminalCard result Zawiera numer referencyjny karty z danymi do wykonania wydruku paragonu rejestracji na terminalu.
GeneralError error
Typy danych
RegisteredTerminalCard
nazwa typ opis
ccToken string Numer referencyjny karty.
ReceiptHeader string Tekst nagłówka wydruku terminala zawiera dane sprzedawcy.
ReceiptText string Treść wydruku terminala:

• informacja o rezultacie rejestracji karty • treść the cardholder agreement to charge his card. • Zamaskowany numer karty płatniczej z widocznymi ostatnimi 4 cyframi. • typ karty (Visa/MasterCard etc) • miejsce na podpis właściciela karty

ReceiptFooter string Dowolny tekst informacyjny dostarczony przez sprzedawcę.
GeneralError
errorCode int Numeryczny kod błędu.
errorMessage string Opis błędu.
errorMessagePl string Opis błędu w języku polskim.

ExecuteTerminalPayment

Parametry Wejściowe
login string ID sprzedawcy
pass string Klucz API webserwisu
ccToken string Unikalny numer referencyjny karty kredytowej zarejestrowany poprzez metodę RegisterTerminalCard.
amount int Kwota obciążenia.
currency string Kod waluty w standardzie ISO4217
Paramerty Wyjściowe
PaymentStatus result Detale płatności
GeneralError error
Typy danych
PaymentStatus
status string Zawiera słowo “SUCCESS” jeżeli płatność została wykonana poprawnie, jeżeli pole nie jest puste.
id string Id płatności w systemie Przelewy24.
amount string Kwota płatności w najmniejszej jednostce waluty.
currency string Kod waluty w standardzie ISO4217
date string Data w formacie: YYYY-MM-DD HH:MM:SS. Przykład: 2015-08-31 12:10:45 GeneralError
errorCode int Numeryczny kod błędu.
errorMessage string Opis błędu.
errorMessagePl string Opis błędu w języku polskim.

RegisterTerminalCardAndPayment

Parametry Wejściowe
login string ID sprzedawcy.
pass string Klucz API webserwisu.
clientID string ID klient z systemu sprzedawcy.
transactionID string ID transakcji.
terminalID string ID terminala.
ccNumber string Numer karty płatniczej (tylko cyfry).
ccExp string Data ważności karty w formacie YYYY-MM-DD lub YYMM. Przykład: 2015-08-31 1508
cvv string Kod weryfikacyjny karty.
amount int Kwota obciążenia.
currency string Kod waluta w standardzie ISO4217.
Parametry Wyjściowe
RegisteredTerminalCardAndPaymentStatus result Zawiera obiekty:

– registeredTerminalCard – paymentStatus Opisy typów poniżej metod RegisterTerminalCard i ExecuteTerminalPayment

GeneralError error

VerifyTerminalPayment

Parametry Wejściowe
login string ID sprzedawcy
pass string Klucz API webserwisu
ccToken string Unikalny numer referencyjny karty kredytowej zarejestrowany poprzez metodę RegisterTerminalCard.
amount int Kwota obciążenia.
currency string Kod waluta w standardzie ISO4217
orderId string Pole id z typu PaymentStatus zwracanego przez ExecuteTerminalPayment.
Paramerty Wyjściowe
PaymentStatus result Detale płatności
GeneralError error

TransactionMotoRegister

Parametry wejścia
Parametr Typ Wymagane Opis
ID_akceptanta INT Tak Identyfikator sprzedawcy w systemie Przelewy24.
Kwota INT Tak Kwota podana w groszach Np. 12,50 PLN = 1250.
Tytuł STRING(120) Tak Tytuł/opis transakcji
E-mail STRING(50) Tak Adres e-mail klienta
Imię STRING(50) Tak Imię osoby, na którą wystawiona jest karta.
Nazwisko STRING(50) Tak Nazwisko osoby, na którą wystawiona jest karta.
Typ INT Nie 0 – po przeprowadzeniu transakcji połączenie telefoniczne jest kończone. 1 – po przeprowadzeniu transakcji klient jest przekierowany z powrotem do Call Center.
CRC STRING(10) Tak Obliczana suma kontrolna
Parametry wyjścia
Parametr Typ Opis
Order_id INT Identyfikator transakcji w systemie Przelewy24.

TransactionMotoStatus

Parametry wejściowe
Parametr Typ Wymagane Opis
ID_akceptanta INT Tak Identyfikator sprzedawcy w systemie Przelewy24.
Order_id INT Tak Identyfikator transakcji otrzymany z systemu Przelewy24.
CRC STRING(10) Tak Obliczana suma kontrolna
Parametry Wyjścia
Status (id_status)
1 Oczekuje na podanie numeru karty
2 Oczekuje na podanie daty ważności
3 Oczekuje na podanie kodu CVV
4 Oczekuje na potwierdzenie
5 Autoryzacja pozytywna
6 Odmowa autoryzacji
9 Przerwano
Kod błędu (errcode):
01 błędny format imienia
02 błędny format nazwiska
03 błędny format kwoty
04 niewłaściwy forma id sesji/transakcji
05 niewłaściwa wartość w typie połączenia zwrotnego

TransactionMotoBreak

Parametry wejścia
Parametr Typ Wymagane Opis
ID_akceptanta INT Tak Identyfikator sprzedawcy w systemie Przelewy24.
Order_id INT Tak Identyfikator transakcji otrzymany z systemu Przelewy24
Redirect INT Tak 1- Przekieruj użytkownika do Call Center
CRC STRING(10) Tak Obliczana suma kontrolna
Parametry wejścia
Result true/false

execBlik

Parametry wejścia
login string Id of seller account
pass string Webservices password
token string Transaction’s TOKEN
kod string BLIK code
Parametry wyjścia
execBlikResult boolean Notice:

true – code was correct and has been successfully processed by BLIK service. Payment status will be sent to the url-status given during the transaction registration process.

false – code was either wrong, or could not be processed. Status will not be sent.

1 Access denied Occurs if login and/or password are incorrect, or IP address hasn’t been set in Przelewy24 system
631 Internal system error
10000 Unknown error

MerchantRegister

<?php
$merchantId = null; 
$anUniqueKeyRetrievedFromPrzelewy24 = null; 
$url  = "https://secure.przelewy24.pl/external/{$merchantId}.wsdl"; 

$merchantRegisterRequest = new stdClass(); 
$merchantRegisterRequest->business_type = 1; 
$merchantRegisterRequest->name = 'Jan Kowalski'; 
$merchantRegisterRequest->email = 'jan.kowalski@example.com'; 
$merchantRegisterRequest->pesel = 'numerpesel'; 
$merchantRegisterRequest->phone_number = '123123123'; 
$merchantRegisterRequest->bank_account = 'numerkonta'; 
$merchantRegisterRequest->representatives = []; 
$merchantRegisterRequest->contact_person = new stdClass(); 
$merchantRegisterRequest->contact_person->name = 'Jan Kowalski'; 
$merchantRegisterRequest->contact_person->email = 'jan.kowalski@example.com'; 
$merchantRegisterRequest->contact_person->phone_number = '123123123'; 
$merchantRegisterRequest->technical_contact = new stdClass(); 
$merchantRegisterRequest->technical_contact->name = null; 
$merchantRegisterRequest->technical_contact->email = null; 
$merchantRegisterRequest->technical_contact->phone_number = null; 
$merchantRegisterRequest->address = new stdClass(); 
$merchantRegisterRequest->address->country = 'PL'; 
$merchantRegisterRequest->address->city = 'Miasto'; 
$merchantRegisterRequest->address->post_code = '11111'; 
$merchantRegisterRequest->address->street = 'Ulica'; 
$merchantRegisterRequest->correspondence_address = new stdClass(); 
$merchantRegisterRequest->correspondence_address->country = null; 
$merchantRegisterRequest->correspondence_address->city = null;
$merchantRegisterRequest->correspondence_address->post_code = null; 
$merchantRegisterRequest->correspondence_address->street = null; 
$merchantRegisterRequest->invoice_email = 'jan.kowalski@example.com'; 
$merchantRegisterRequest->shop_url = 'http://nazwastrony.pl'; 
$merchantRegisterRequest->services_description = ''; 
$merchantRegisterRequest->trade = 'agd'; 
$merchantRegisterRequest->krs = null; 
$merchantRegisterRequest->nip = null; 
$merchantRegisterRequest->regon = null; 
$merchantRegisterRequest->acceptance = true; 

$client = new SoapClient($url); 

$response = $client->MerchantRegister($merchantId, $anUniqueKeyRetrievedFromPrzelewy24, $merchantRegisterRequest); 

if ($response->error->errorCode) { 
    echo 'Something went wrong: '.$response->error->errorMessage; 
} else { 
    echo 'Merchant registered'; 
}
?>
Parametry wejścia
Nazwa parametru Typ Wymagany Opis
business_type Int Tak Rodzaj działalności, wartości dopuszczalnew tabeli „Rodzaj działaności”
name String Tak Nazwa
email String Tak Adres email
pesel String Wymagany w przypadku rejestracji osoby fizycznej (business type = 1) Numer pesel
phone_number String Tak w formacie xxxxxxxxx Numer telefonu
bank_account String Tak Numer kontabankowego
representatives Representative[] Wymagany w przypadku rejestracji firmy (business type != 1) Reprezentanci
contact_person Object_ContactPerson Tak Osoba kontaktowa
technical_contact Object TechnicalContact Nie Osoba do kontaktu technicznego
address Object Address Tak Adres_
correspondence_address Object CorrespondenceAddress Nie Adres do korespondencji
invoice_email String Tak Adres email do faktur
shop_url String Parametr nie jest wymagany o ile zostanie przesłane pole services_description, format http(s)://nazwasklepu.pl Adres www strony internetowej
services_description String Parametr nie jest wymagany o ile zostanie przesłane pole shop_url Opis świadczonych usług
trade String Tak Branża, lista dostępna w tabeli „Branża”
krs String Tylko w przypadku business_type = 2 Numer krs
nip String Wymagany w przypadku rejestracji firmy (business_type != 1) Numer nip
regon String Wymagany w przypadku rejestracji firmy (business_type != 1) Numer regon
acceptance Boolean Tak Określa czy konto ma zostać aktywowane natychmiast
MerchantRegisterRequest
Nazwa parametru Typ Wymagany Opis
login Int Tak ID sprzedawcy w systemie Przelewy24
pass String Tak Klucz do WS uzyskany z Przelewy24
MerchantRegisterRequest Object Tak Obiekt zawierający niżej przedstawione pola


Representative
Nazwa parametru Typ Wymagany Opis
name String Tak Imię oraz nazwisko
pesel String Tak Numer pesel


ContactPerson
Nazwa parametru Typ Wymagany Opis
name String Tak Imię oraz nazwisko
email String Tak Adres email
phone_number String Tak, format xxxxxxxxx Numer telefonu
TechnicalContact
Nazwa parametru Typ Wymagany Opis
name String Tak Imię oraz nazwisk
email String Tak Adres email
phone_number String Tak, format xxxxxxxxx Numer telefonu


Address
Nazwa parametru Typ Wymagany Opis
country String Tak, dostępna tylko wartość ‘PL’ Kraj, dostępna wartość ‘PL’
city String Tak Miasto
post_code String Tak,format xx-xxx lub xxxxx Kod pocztowy
street String Tak Ulica
CorrespondenceAddress
Nazwa parametru Typ Wymagany Opis
country String Tak, dostępna tylko wartość ‘PL’ Kraj, dostępna wartość ‘PL’
city String Tak Miasto
post_code String Tak,format xx-xxx lub xxxxx Kod pocztowy
street String Tak Ulica
Parametry wejścia
Obiekt MerchantRegisterResult
Nazwa_parametru Typ Opis
result array W przypadku poprawnej odpowiedzi tablica zawiera pola: - merchant_id – int – identyfikator utworzonego konta - crc_key - string – klucz CRC - link – string – link do dokończenia rejestracji natomiast w przypadku błędu, parametr result to pusta tablica
error GeneralError Object
GeneralError
Nazwa parametru Typ Opis
errorCode int Identyfikator błędu
errorMessage String Informacja tekstowa


Rodzaje działalności
Wartość Opis
1 Osoba fizyczna
2 Jednoosobowa działalność gospodarcza
3 Spółka cywilna
4 Spółka jawna
5 Spółka komandytowa
6 Spółka komandytowo-akcyjna
7 Spółka akcyjna
8 Spółka z ograniczoną odpowiedzialnością
9 Stowarzyszenie, fundacja, organizacja pożytku publicznego
10 Spółdzielnia
Branża
Wartość pola trade Opis
agd AGD
agdrtv AGD i RTV
alkoh Alkohole
apteki Apteki
artlab Artykuły laboratoryjne
artmed Artykuły medyczne
artspoz Artykuły spożywcze
aukcje Aukcje
behape BHP
blizna Bielizna
bilety Bilety
buki Bukmacher
biz Biżuteria i zegarki
budow Budownictwo
chemia Chemia
czaspis Czasopisma
dekor Dekoracje
dewoc Dewocjonalia
domiogr Dom i ogród
dziecko Dziecko
elektronika Elektronika
epapier E-papierosy
ezoter Ezoteryka
filatel Filatelistyka
finanse Finanse
fotogr Fotografia
fundacja Fundacja
galant Galanteria
gadzet Gadżety
gry Gry
komphost Hosting
hotel Hotelarstwo
instyt Instytucje
komputery Komputery
ksiazki Książki
kosmetyki Kosmetyki
ksieg Księgarnia
kip Kwiaty i prezenty
mwf Masowi Wystawcy Faktur
maszyny Maszyny
matbiur Materiały biurowe
matfol Materiały foliowe
matpap Materiały papierowe
militaria Militaria
motoryz Motoryzacja
mim Multimedia i muzyka
nagrob Nagrobki
narzedzia Narzędzia
nis Nauka i szkolnictwo
numiz Numizmatyka
obuwie Obuwie
odziez Odzież
ogl Ogłoszenia
ogrod Ogród
oprogra Oprogramowanie
oswietl Oświetlenie
pasman Pasmanteria
podroze Podróże
randki Portal randkow
portfel Portfel elektroniczny
prasa Prasa
prawo Prawo
kurier Przesyłki kurierskie
reklama Reklama
rekodz Rękodzieło
rodzice Rodzice
rtv RTV
serint Serwis internetowy
sklmuz Sklep muzyczny
siw Sport i wypoczynek
suplem Suplementy diety
szklo Szkło
szkol Szkolenia
sztuka Sztuka
slubne Ślubne
tif Teatr i film
telek Telekomunikacja
tkan Tkaniny
twstrwww Tworzenie stron WWW
ubezp Ubezpieczenia
uslugi Usługi
wielob Wielobranżowość
wpc WP - conceptshop.pl
wypmiesz Wyposażenie mieszkania
wypsklep Wyposażenie sklepów
wyrtyt Wyroby tytoniowe
wio Wzrok i okulary
vod Vod
zabawki Zabawki
zik Zdrowie i kosmetyki
zwierz Zwierzęta

GetTransactionFunds

Parametry wejścia
nazwa typ opis
login string Partner ID in Przelewy24 system
pass string Unique key retrieved from Przelewy24
orderId int Order ID of a transaction
sessionId string Session ID of a transaction
Parametry wyjścia
nazwa typ opis
return GetTransactionFundsResult Dwa obiekty: error (GeneralError) oraz result (int)

GetPayerInformationByOrderId

<?php
$soap = new SoapClient("http://secure.przelewy24.pl/external/MERCHANT_ID.ws
dl");
$getPayerInformation = $soap->GetPayerInformationByOrderId(
 "123456",
 "asdfgh",
 array(
 array(
 "orderId" => "654321",
 "sessionId" => "a1s2d3f4"
 )
 )
);
pri
Parametry wejścia
Nazwa Typ Opis
login string ID sprzedawcy
pass string Klucz API webserwisu
list array Lista zawierająca order ID i session ID
Parametry wyjścia
Nazwa Typ Opis
return array Order ID, imię i nazwisko, IBAN