Webhooks
A webhook is an API that providers near real-time information. PayTel uses webhooks to inform the merchants regarding changes on a Transaction payment status.
The Merchant can receive the notifications either by email or endpoint (notification assembling to the status inquiry – Checkout Status), however only a notification will be sent for each transaction.
Notifications are sent by endpoint straight to the URL configured by the Merchant. The parameterization of this endpoint needs to be done on the Gateway BackOffice.
Learn how to create a webhook on the Gateway BackOffice.
Each time that Gateway receives an update on the payment status of a transaction a notification will be sent with the new transaction payment status.
Every day a summarized email with the most recent failed notifications, is sent by the Gateway (email needs to be registered on the BackOffice).
There is no guarantee on the order of messages, especially if the time difference between the notifications is smaller than the time it takes to process them or by any communication or systems issues. Once the issues are sort out, new notifications will arrive in real time and old notifications would be resent. In case no notification is received the option “Checkout Status” should be used before rejecting any transaction.
Notifications are sent as HTTP callbacks (webhooks) to an endpoint on your server. Please ensure you have a valid SSL certificate chain. Self-signed certificates are not valid.
To receive notifications, you need a server that has:
Depending on your network and security requirements, you might also need to add our network to your firewall's whitelist.
To ensure that your server is properly accepting notifications, we require you to acknowledge every notification of any type with an HTTP 200 and a response containing:
{
"statusCode": "200",
"statusMsg": "Success",
"notificationID": "2533e456-5e36-42c8-9eea-7961902f185e"
}
When your server receives a notification it should:
{ "statusCode": "200", "statusMsg": "Success","notificationID": "2533e456-5e36-42c8-9eea-7961902f185e" }
Decrypt
The content of notification is encrypted to protect data from fraud attempts. When converting human-readable string to hexadecimal format, we use UTF-8.
Format of body: Base64 Format of Initialization Vector: Base64
Secret:
|
O0Bur9uhZkS54NkwFhVyeutED6DhLbOQUBDt3i3W/C4= |
X-Authentication-Tag:
|
Ytw9bzOS1pXqizAKMGXVQ== |
Content-Type:
|
text/plain |
X-Initialization-Vector:
|
Ldo3OyWNgRchSF3C |
Body before decryption:
|
WgErmJOV6wg3BuRkrgZLUUnh57BYzhIzvBFdpadHRsc43UcjtZEevRGDIDu3YxocXMXe8O+xQpMRxwTJPv766IaNqUiUEjAIj ZSMEYCZ0pBursUYB+9nB4eqNUiAS2MJ9sR+Cj2iBf6G6KXLfp9K6dK7c0UED5XrJwbovY8X8pMyxktFTEaflp0e76ZywsCQvt qEtqNz9uYEyqmAANbsBwbwyWpkCC8H1kZN2fV3CYetW1CTPmWdPp3C18Yfh826NN4XlKu1VmUmea70PyjmRKSsjPXpfrRX8ud elVIK2WTFtnRxD4x588d1nlGY5D5DQmJ8KYZzfvjTmDXGAPiRIEGuXp8h6rBQXS8P/m1llBtboGgQv4MmW3zvq0G6KFlYIcM= |
Body after decryption:
|
{ "returnStatus": { "statusMsg": "Success", "statusCode": "000" }, "paymentStatus": "Success", "paymentMethod": "CARD", "transactionID": "WebhookTest", "amount": { "currency": "EUR", "value": 10.0 }, "merchant": { "terminalId": 1000000 }, "paymentType": "PURS", "notificationID": "f153c248-e7be-4c12-8d88-6c9f1f3b83e4" } |
Examples
Below there are 4 examples of how to decrypt the webhook notification
|
|
|
|
SPG Payment Form
Available Payment Methods?
The gateway offers integration with major international card processing schemes such as Visa and Mastercard.
Pay by link is a reliable, convenient and secure way to get paid by consumers and businesses alike. Merchants handling telephone transactions can benefit from this solution, while this payment channel opens up a whole host of opportunities for businesses of all sizes, across sectors. It allows customers to make payments by sending them a web payment link, meaning card details do not have to be shared over the phone or text message.
BLIK is the most popular mobile payment system in Poland that allows users to make instant payments using only the user's standard mobile banking app. BLIK payments are convenient and safe – you enter the BLIK code and confirm the transaction with your PIN in the banking app. You do not have to log in to online banking, enter SMS passwords or provide your payment card details.
Credentials
How to get your credentials ?
Below you can find instructions on how to get your credentials.
TerminalId
|
Provided by Onboarding on your credential kit |
X-IBM-Client-Id
|
Provided by Onboarding on your credential kit |
Bearer / Access Token
|
Provided by Onboarding on your credential kit |
Payment type
|
For single message transactions - PURS For two-message transactions - AUTH |
Payment Method
|
Selected when you sign the contract with your Acquiring entity |
TerminalId
|
Obtained on SIBS BackOffice, or provided by Onboarding team |
X-IBM-Client-Id
|
Obtained on SIBS BackOffice, or provided by Onboarding team |
Bearer / Access Token
|
Obtained on SIBS BackOffice |
Payment type
|
For single message transactions - PURS For two-message transactions - AUTH |
Payment Method
|
Selected when you sign the contract with your Acquiring entity |