Note : Please let us know your server IP list before start integration for whitelisting on our system. Note 2 : Please do not send dummy data for required fields. Note 3 : The purchaseUrl in the response of the initializePayment method will be opened in iframe in the browser.
Payment
Live URL: https://api. /pw/v3/initializePaymentTest URL: https://testapi. /pw/v3/initializePayment
CURL API REQUEST
Parameters
| Parameter Name | Detail | Example | Type | Always There |
|---|---|---|---|---|
| apiKey | Your Api Key provided from us. | 4d41d21a935f5bba9dee7 c7be4a7ca04 | Char 32 | ✔ |
| Customer email address | [email protected] | Char 128 | ✔ | |
| birthday | The customer birth date. | 1970-01-01 | YYYY-MM-DD | ✔ |
| amount | Amount in cents of the transaction. | 1234 for 12.34 € 1550 for 15.50 USD | Int | ✔ |
| currency | The currency of transaction. | EUR | Char 3 | ✔ |
| returnUrl | Valid URL where the client is redirected after payment completion. | https://www.yourstore.co m/order_confirmation_132 2_ABC | Char 256 | ✔ |
| referenceNo | Your own transaction identifier. | 1-1386413490-0089-14 | Char 32 | ✔ |
| descriptor | Statement descriptor | Test | Char 256 | |
| language | Payment Language | Please check Supported languages | Char 2 | |
| billingFirstName | First name of the customer. | John | Char 64 | ✔ |
| billingLastName | Last name of the customer. | Doe | Char 64 | ✔ |
| billingCompany | The customer company. | Test srl. | Char 256 | |
| billingAddress1 | The customer address 1. | 26 green street | Char 128 | ✔ |
| billingAddress2 | The customer address 2. | 28 red street | Char 128 | |
| billingCity | The customer city. | Paris | Char 64 | ✔ |
| billingPostcode | The customer zip code. | 75001 | Char 16 | ✔ |
| billingCountry | The customer country. | FR | Char 2 | ✔ |
| billingState | The customer state. | FR | Char 2 | |
| billingPhone | The customer phone number.(Full international number) | +905678764567 | Char 16 | ✔ |
| paymentMethod | Default selected payment method | Please check Supported payment methods | Char 32 | ✔ |
| storeCard | Store Card For Next Payment | yes/no | Char 3 | |
| isPreAuth | Allow to first authorize a charge on a card | yes/no | Char 3 | |
| sessionId | A unique identifier of the user session, for example tracking cookies. | DLFJKFU474949H497 | Char 255 | |
| passwordHash | Hash of the user’s password in ASCII encoding (e.g. MD5, SHA-2 family) | JKFSDF4573637DHFHFH | Char 255 | |
| userCreated | Date of user first registered to your site in UNIX time format and UTC time zone. | 1446370717 (Sun, 01 Nov 2015 09:38:37 +0000) | Char 255 | |
| walletId | A unique identifier of wallet. | 11604623c851ff74d060d8f5240056531 | Char 255 |
* If MCC is not 6012, birthday parameter is not required
If you want to send prepopulate creditcard details in the request, you can add the following parameters.
| Parameter Name | Detail | Example | Type | Always There |
|---|---|---|---|---|
| number | Creditcard number. | 4012888888881881 | Char 16 | |
| expiryMonth | Expiry month of creditcard. | 09 | Int | |
| expiryYear | Expiry year of creditcard. | 2020 | Int | |
| cvv | CVV | 123 | Char 4 |
Response Examples
Successful Response
| Parameter Name | Detail | Example |
|---|---|---|
| status | Status of the transaction | PENDING |
| amount | Amount in cents of the transaction. | 1234 for 12.34 € 1550 for 15.50 |
| currency | The currency of transaction | EUR |
| type | Authorization type | AUTH |
| referenceNo | Your own transaction identifier. | 1-1386413490-1289-14 |
| operation | The operation type | 3D |
| returnUrl | Valid URL where the client is redirected after payment completion. | https:// /return |
| paymentMethod | Default selected payment method | VISA |
| transactionId | Our transaction identifier | 123-123456789-123456 |
| message | Return message that includes details for response | Waiting |
| code | Response code of the message | 283 |
| purchaseUrl | The URL which for your customers to be redirected to | https://gateway. /payment/initialize/12-32345-3424323 |
Unsuccessful Response
| Parameter Name | Detail | Example |
|---|---|---|
| status | Status of the transaction | DECLINED |
| message | Return message that includes details for response | Amount is required |
| code | Response code of the message | 188 |
Supported Default Payment Method Codes
If you provide one of at the below variable, your customer by pass the payment method select screen
- CREDITCARD
- VISA (by Voucher)
Supported Languages
| Language | Code |
|---|---|
| English | en |
| French | fr |
| Turkish | tr |
| Chinese | cn |
| German | de |
| Norwegian | no |
| Japanese | ja |
| Polish | pl |
| Russian | ru |
Processing Integration Test
Credit Card
- Which card numbers should I use for testing?
| Number | Brand | Description |
|---|---|---|
| 4012888888881881 | VISA | APPROVED |
| 4242424242424242 | VISA | DECLINED |
| 4900000000000086 | VISA | NOTENROLLED |
| 5500000000000004 | MASTERCARD | APPROVED |
| 5200000000000007 | MASTERCARD | DECLINED |
- For Credit Card testing, you can use any three digit number for CVV and a valid future
day for Expration Date.
- CVV : 123
- Expiry Date : 10/2025
Redeem Process
Our system automaticlly generates voucher codes at the below payment methods
* Visa
* Gift Card
* Ideal
* China Union Payment
If you are going to use one of these payment you must implement at the below parts. Otherwise, you will not able to receive transaction result.
Print Redeem Form
We are automatically generate a redeem form which is generated in the response parameters. You must base64decode the “ returnForm” and print into your return page.
!! IMPORTANT !!
When the redeem process completed customers will stay at merchants return page which is provided by request parameter (returnUrl)
<?php echo base64_decode($_REQUEST[‘returnForm’]); ?>
Example Integration Request
curl -i -X POST \
-d "amount=200" \
-d "apiKey=1234ABCD" \
-d "currency=EUR" \
-d "[email protected]" \
-d "referenceNo=asd23" \
-d "returnUrl=https://google.com/return" \
-d "billingFirstName=John" \
-d "billingLastName=Wayne" \
-d "billingAddress1=Fake Street" \
-d "billingCity=Gotham City" \
-d "billingCountry=DE" \
-d "billingState=DE" \
-d "billingPhone=+905678764567" \
-d "billingPostcode=00007" \
-d "birthday=1990-12-12" \
-d "number=4012888888881881" \
-d "expiryMonth=09" \
-d "expiryYear=2022" \
-d "cvv=123" \
-d "paymentMethod=VISA" \
'REQUEST_ENDPOINT_URL_COMES_HERE(SEE BELOW)'
Test URL: https://testapi. /pw/v3/initializePaymentLive URL: https://api. /pw/v3/initializePayment