Download OpenAPI specification:
The Voucher Elite Payments widget for voucher's purchase with BLIK payment solution. Our API allows clients to create transactions and manage payments. This documentation provides details on how to authenticate and interact with the API endpoints.
Base url for api calls: https://payments.voucher-elite.com
Test mode: in this mode you will be able to make a real payment for 0,01 PLN.
Instead of code from text message use fixed code: 777 777
Test credentials:
client_id: KIIoT56mwQV9SI4xTr
client_secret: GYst9Wn0LlhNL86VZVU0
Production mode: fully operational. Contact support to launch onboarding process and get production credentials Key features (production mode):
When you use access token which is no longer valid or is not valid in the location where your request has been routed, than you may receive on any API call response - 401 Unauthorized:
{
"error": "invalid_token",
"error_description": "The access token expired"
}
Then you need to get a new tokens using API call to /api/login/single-step-default-scope In case when you are being routed to other location, all your request will be routed there for some time, so you don’t have to worry that every request might end in different location.
This documentation provides an overview of the essential components and endpoints for interacting with the Vocuher Elite Payments API. For further assistance, please refer to the support team.
Obtain an access token using client credentials
Notes
| client_id | string |
| client_secret | string Client password |
| grant_type | string Type of authentication mechanism. |
{- "client_id": "KIIoT56mwQV9SI4xTr",
- "client_secret": "GYst9Wn0LlhNL86VZVU0",
- "grant_type": "client_credentials"
}{- "access_token": "S0lJb1Q1Nm13UVY5U0k0eFRy.YvRLzh1N....",
- "token_type": "bearer",
- "expires_in": "1199",
- "refresh_token": "S0lJb1Q1Nm13UVY5U0k0eFRy.YvRLzh1NBE/vXkUtm…."
}Create a new transaction.
string Sender's email address. | |
| environment | string Can be "test" for testing environment or "prod" for production environment. |
| phone | string Sender's phone number. Phone number must have preceeding prefix unique for each country. |
| name | string Sender's Name. |
| surname | string Sender's Surname. |
| merchant_transaction_id | string Unique transaction ID in the client's system |
| amount | decimal Amount in selected currency. |
| currency | string The only allowed values are "EUR" or "PLN". |
| success_url | string URL to redirect to upon successful transaction. |
| fail_url | string URL to redirect to upon transaction failure. |
{- "email": "sender@example.com",
- "environment": "test",
- "phone": "+48123456789",
- "name": "Marek",
- "surname": "Nowak",
- "merchant_transaction_id": "unique-id-123",
- "amount": 1.00000001,
- "currency": "EUR",
}{- "transaction_id": "72b9e52b-27dd-44d3-85ca-0ffd3236f3e8",
}Automatic webhook executed upon transactions tatus change between inProgress/approved/failed statuses. Sends the transactions tatus to the client system.
| transaction_id | string Transaction ID | ||||||||||||||||||||||||||||
| merchant_transaction_id | string Transaction ID from client system | ||||||||||||||||||||||||||||
| status | string Transaction status.
| ||||||||||||||||||||||||||||
| detailed_status | string Detailed transaction status.
| ||||||||||||||||||||||||||||
| amount | decimal Transaction amount | ||||||||||||||||||||||||||||
| currency | string | ||||||||||||||||||||||||||||
| method | string | ||||||||||||||||||||||||||||
| environment | string |
{- "transaction_id": "72b9e52b-27dd-44d3-85ca-0ffd3236f3e8",
- "merchant_transaction_id": "1a0a1977-82aa-42d2-9447-6b975eff21ad",
- "status": "approved",
- "detailed_status": "string",
- "amount": 1.00000001,
- "currency": "EUR",
- "method": "BLIK",
- "environment": "test"
}Gets the status of a transaction.
| transactionId required | string The ID of the transaction |
{- "transaction_id": "72b9e52b-27dd-44d3-85ca-0ffd3236f3e8",
- "merchant_transaction_id": "1a0a1977-82aa-42d2-9447-6b975eff21ad",
- "status": "approved",
- "detailed_status": "string",
- "amount": 1.00000001,
- "currency": "EUR",
- "method": "BLIK",
- "environment": "test"
}