Note! If you are a Platform (ak.a. BaaS Partner), please use the documentation here.
To create and execute single merchant payments that require redirection, you will need to call our Initiate Payment API. The purpose of this API is to receive commercial transactions to Your account. Before calling this API we strongly recommend selecting payment method (PIS – for payment initiation service, CARD, GooglePay, ApplePay – for card-related payments), provider (applicable only for PIS payment method) and language (all these parameters are optional) – to save clicks and steps for your customer.
For testing only. When testing requests in the stage environment, please note that not all providers support the frontend. We recommend selecting these details while testing:
1. For DE country and PIS method – Fake Bank with Client Keys (enter it in search), provider ID c3e4f215-dde4-4d0c-9a48-bc7274c90977 . Test credentials:
User: username
Password: secret
Confirmation code: 123456
2. For LT country and PIS method – Siauliu bankas, provider ID a7640cb7-4dec-4a44-a9ad-b918c803254e
When testing CARD requests in the stage environment, you can use such card numbers (CVV -any 3 digits, card expiry – future date):
1. 4242424242424242 – Visa, credit card, success response, 3DS challenge enabled
2. 5436031030606378 – MasterCard, credit card, success response, 3DS challenge enabled
3. 4485040371536584 – Visa, credit card, success response, 3DS frictionless response
4. 4544249167673670 – Visa, credit card, failure response, Insufficient funds
5. 4539253655711767 – Visa, credit card, failure response, Stolen card
6. If you send us amount 99.99 EUR, it will return status PendingProvider, meaning it got stopped for manual review. In non-prod environment such transactions are not approved, unless you contact us.
When testing Apple Pay requests, follow the process defined here Sandbox Testing – Apple Pay – Apple Developer
When testing Google Pay requests, follow the process for mocked cards here.
If the request was successful, you will receive a response with HTTP code 201 and paymentId together with redirectUrl in the response body. You have to redirect your customer to redirectUrl to authorize a payment with their provider (bank or card issuer). Save paymentId for further status check.
"payment": {
"paymentId": "07400128-60a9-47cc-8c99-924cb079a32b",
"redirectUrl": "https://pay-stage.connectpay.com?key=c5781691-c81c-42f3-8290-ae11b07fe74c"
}You can see the full sequence diagram below:
After authorization within their bank or issuer, the Consumer will be redirected back to the widget and will be presented with payment status information. All commercial transactions require SCA for payments or 3DS authorization for card-related payments. Exemptions might be applied by the Consumer’s bank or Issuer.
Sometimes, the provider may not respond immediately with the final payment status information. In such cases, we will periodically check with the Provider for final status and update payment information. In the same way, you should periodically check payment status using the Get payment details API or you will receive a payment status notification if you have provided notificationUrl in the Initiate Payment API request. Notification have the same body as the Get payment details API response.
As a final step of the payment journey, by pressing the button Return to Merchant, Consumer will be redirected back to your website using the web address provided via redirectUrl parameter in the Payment Initiation API request.
Tip! Delivery of a payment might be different (not all providers support SEPA INST), please check providers and schemes they support here.