Page tree
Skip to end of metadata
Go to start of metadata

Wprowadzenie

Mechanizmy WebHook udostępniane są tylko partnerom platformy inviPay.com. Prosimy o kontakt, w przypadku chęci skorzystania z opisanych tutaj mechanizmów.

Partnerzy platformy inviPay mają możliwość skorzystania z mechanizmów WebHook, przesyłających asynchronicznie dane o niektórych zdarzeniach systemowych. Pozwala to na ściślejszą integrację z platformą oraz eliminację mechanizmów opartych na cyklicznym odpytywaniu inviPay o wyniki operacji asynchronicznej, na rzecz otrzymywania tych zdarzeń w momencie ich wystąpienia na wskazny adres URL.

Dokumentacje poszczególnych WebHooków

Informacje, o dostępnych WebHookach znajdziesz w dokumentacji poszczególnych punktów dostępowych:

Rejestracja WebHooków

Rejestracja WebHooków polega na skonfigurowaniu, na platformie inviPay, adresu URL, pod który będą przesyłane dane odpowiednich zdarzeń. W celu rejestracji lub chęci zmiany adresu prosimy o kontakt.

Przesyłanie i format danych

Dane będą przesyłane za pomocą protokołu HTTP (metoda POST), pod wskazany adres URL. Format przesyłanych danych to do wyboru JSON lub XML (format należy określić podczas rejestracji). Wszystkie zdarzenia będą przesyłane jako obiekt typu WebHookEvent, którego pole eventData będzie niosło ze sobą faktyczny obiekt danych zdarzenia.

Przykład dla zdarzenia ContractorVerificationCompletedEvent

 Pokaż przykład
PoleTyp danychWartość 
 eventTypeStringContractorVerificationCompletedEvent
 
timestampDate2016-02-24T18:57 

eventData

VerificationResult

Dane weryfikacji kontrahenta

PoleTyp danychOpis 
operationIdStringUnikalny identyfikator operacji weryfikacji 

taxPayerNumber

StringNIP firmy 

companyGovId

StringREGON firmy 

status

VerificationStatus

Status weryfikacji

Typ wyliczeniowy

WartośćZnaczenie

PENDING

Oczekuje na weryfikacje

VERIFIED

Kontrahent pozytywnie zweryfikowany

NOT_VERIFIED

Kontrahent negatywnie zweryfikowany

ERROR

Bład weryfikacji

WYMAGANE

message

StringEwentualna dodatkowa informacja (głównie w przypadku błędu weryfikacji) 
public class VerificationResult
{
	
	public String OperationId { get; set; }
	public String TaxPayerNumber { get; set; }
	public String CompanyGovId { get; set; }
	public VerificationStatus Status { get; set; }
	public String Message { get; set; }
	
}
public class VerificationResult {
	
	protected String operationId;
	protected String taxPayerNumber;
	protected String companyGovId;
	protected VerificationStatus status;
	protected String message;
	
	public String getOperationId() {
		return this.operationId;
	}
	
	public void setOperationId(String operationId) {
		this.operationId = operationId;
	}
	
	public String getTaxPayerNumber() {
		return this.taxPayerNumber;
	}
	
	public void setTaxPayerNumber(String taxPayerNumber) {
		this.taxPayerNumber = taxPayerNumber;
	}
	
	public String getCompanyGovId() {
		return this.companyGovId;
	}
	
	public void setCompanyGovId(String companyGovId) {
		this.companyGovId = companyGovId;
	}
	
	public VerificationStatus getStatus() {
		return this.status;
	}
	
	public void setStatus(VerificationStatus status) {
		this.status = status;
	}
	
	public String getMessage() {
		return this.message;
	}
	
	public void setMessage(String message) {
		this.message = message;
	}
	
}
class VerificationResult {
	
	protected $operationId;
	protected $taxPayerNumber;
	protected $companyGovId;
	protected $status;
	protected $message;
	
	public function getOperationId() {
		return $this->operationId;
	}
	
	public function setOperationId($operationId) {
		$this->operationId = $operationId;
	}
	
	public function getTaxPayerNumber() {
		return $this->taxPayerNumber;
	}
	
	public function setTaxPayerNumber($taxPayerNumber) {
		$this->taxPayerNumber = $taxPayerNumber;
	}
	
	public function getCompanyGovId() {
		return $this->companyGovId;
	}
	
	public function setCompanyGovId($companyGovId) {
		$this->companyGovId = $companyGovId;
	}
	
	public function getStatus() {
		return $this->status;
	}
	
	public function setStatus($status) {
		$this->status = $status;
	}
	
	public function getMessage() {
		return $this->message;
	}
	
	public function setMessage($message) {
		$this->message = $message;
	}
	
}
{
	"operationId" : null, 
	"taxPayerNumber" : null, 
	"companyGovId" : null, 
	"status" : null, 
	"message" : null, 
	
}

 

 

 

Zabezpieczenia

Przesyłane dane zostaną podpisane kluczem podpisu, przypisanym do konta partnera w systemie inviPay, a tak uzyskany podpis będzie przekazany w nagłówku HTTP o nazwie X-InviPay-Signature. Przeczytaj więcej na stronie Zabezpieczenia.

  • No labels