Bank card (KIPARIS side)

Acquiring. Card data is collecting on the KIPARIS side. Additional fields for /deposit/create request

Пример запроса:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "USD",
    "payment_system": "CardGate",
    "note": "Account deposit 321",
    "system_fields": {
        "client_id": "321"
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to KIPARIS checkout page. After checkout client will be redirected to 3DS and then returned according the url block if present.

Bank card (Merchant side)

Acquiring. Card data is collecting on the Merchant side. Additional fields for /deposit/create request:

Optional fields can be needed in live mode. Please specify it before going live.

Request example:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "USD",
    "payment_system": "CardGateS2S",
    "note": "Account deposit 321",
    "system_fields": {
        "client_id": "321",
        "card_number": "4111111111111111",
        "card_month": "01",
        "card_year": "2020",
        "cardholder_name": "Mr Cardholder",
        "card_cvv": "345"
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to 3DS page. After passing 3DS client will be returned according the url block if present.

Attention! Redirect block can contain different "url", "method" and "params".

The example of the common response:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "CardGateS2S",
    "redirect": {
        "url": "https://bank.com/3ds",
        "method": "POST",
        "params": {
            "pareq": "12345678"
        }
    }
}
    

In some cases answer may not contain redirect block. It could happen in some cases like not enrolled in 3DS card or some unexpected system behavior. Merchant system should await for callback with final status or check status of the transaction by itself.

The example of that kind of response:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "CardGateS2S"
}
    

3DSv2 (Merchant side)

Additional request data needs to be sent to use 3DSv2 authentication method.

Additional fields for /deposit/create request:

Request example:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "USD",
    "payment_system": "CardGateS2S",
    "note": "Account deposit 321",
    "system_fields": {
        "client_id": "321",
        "card_number": "4111111111111111",
        "card_month": "01",
        "card_year": "2020",
        "cardholder_name": "Mr Cardholder",
        "card_cvv": "345"
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    },
    "three_ds_v2": {
        "accept_header": "text/html,application/xhtml+xml,application/xml",
        "java_enabled": true,
        "language": "en-EN",
        "color_depth": 48,
        "screen_height": 800,
        "screen_width": 600,
        "time_zone_offset": "-300",
        "user_agent": "AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0",
        "ip": "127.0.0.1",
    }
}
    

Wallet (KIPARIS side)

Contact your manager to specify if this method is available.

Deposit. Wallet number and additional data are collecting on the KIPARIS side.

The request is sent by POST to the address:

https://psp.kiparisdmcc.ae/api/deposit/create/form

The request is identical as for /deposit/create request of specific wallet method but you don't need to send the wallet number or fields that client could fill in the "system_fields" block.

In case of successful transaction creation the response should be a common redirect response with payment completion form URL:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "Wallet",
    "redirect": {
        "url": "https://psp.kiparisdmcc.ae/payment/checkout/deposit/12345678",
        "method": "GET",
        "params": []
    }
}
    

In case of error occurred the response should be the common error response.

After completion of payment client will be returned to merchant site according the url block if present.

Wallet (Merchant side)

Deposit. Wallet number and additional data are collecting on merchant's side.

The request is sent by POST to the address:

https://psp.kiparisdmcc.ae/api/deposit/create

Refer to specific wallet method section of this documentation to check mandatory request fields.

The examples of the responses:

No action needed, transaction status is not final:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "Wallet"
}
    

Redirect response to complete transaction:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "Wallet",
    "redirect": {
        "url": "https://wallet.com/complete",
        "method": "POST",
        "params": {
            "some": "param",
            "another": "param2",
        }
    }
}
    

Redirect response to complete transaction by entering OTP code (please refer to OTP Merchant Side section for alternative ways of processing):

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "Wallet",
    "redirect": {
        "url": "https://psp.kiparisdmcc.ae/payment/checkout/otp/12345678",
        "method": "GET",
        "params": []
    }
}
    

No action needed, transaction is successful:

{
    "status": "ok",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "Wallet"
}
    

In case of error occurred the response should be the common error response.

Wallet OTP (Merchant side)

There is a possibility to collect OTP code for wallet payment completion on merchant's side.

If merchant got response with redirect block to /payment/checkout/otp/ endpoint, you can draw an input for client to enter OTP code there and then send it to the system.

The request is sent by POST to the address:

https://psp.kiparisdmcc.ae/deposit/complete/otp

Fields for /deposit/complete/otp request:

Request example:

{
    "id": 300,
    "system_fields": {
        "otp": "1234",
    }
}
    

The examples of the responses:

No action needed, transaction status is not final:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "Wallet"
}
    

Redirect response to complete transaction:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "Wallet",
    "redirect": {
        "url": "https://wallet.com/complete",
        "method": "POST",
        "params": {
            "some": "param",
            "another": "param2",
        }
    }
}
    

No action needed, transaction is successful:

{
    "status": "ok",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "10.00",
    "amount_merchant": "9.3",
    "amount_client": "10.00",
    "currency": "USD",
    "payment_system": "Wallet"
}
    

In case of error occurred the response should be the common error response.

EcoPayz

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "EUR",
    "payment_system": "Ecopayz",
    "note": "Account deposit 321",
    "system_fields": {
        "client_first_name": "Ivan",
        "client_last_name": "Ivanov",
        "client_date_birth": "1991-02-13"
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Additional fields for /deduce/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "EUR",
    "payment_system": "Ecopayz",
    "note": "Account payout 321",
    "system_fields": {
        "client_account_number": "1234567890"
    },
    "url": {
        "callback_url": "https://site.com/callback"
    }
}
    

Answer is common KIPARIS payout response.

Privat24

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "UAH",
    "payment_system": "DepositUA",
    "note": "Account deposit 321",
    "system_fields": {
        "user_id": "321",
        "email": "test@test.com",
        "return_url": "http://site.com/return"
    },
    "url": {
        "callback_url": "https://site.com/callback"
    }
}
    

Answer is common KIPARIS response with Redirect block to Privat24 checkout page. After checkout client will be returned according the redirect_url.

Paysafecard

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "EUR",
    "payment_system": "Paysafecard",
    "note": "Account deposit 321",
    "system_fields": {
        "client_success_url": "https://site.com/success",
        "client_failure_url": "https://site.com/fail",
        "client_id": "321"
    },
    "url": {
        "callback_url": "https://site.com/callback",
    }
}
    

Additional fields for /deduce/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "EUR",
    "payment_system": "Paysafecard",
    "note": "Account payout 321",
    "system_fields": {
        "client_id":"321",
        "client_email": "test@test.com",
        "client_date_birth": "1991-02-13",
        "client_first_name": "Ivan",
        "client_last_name": "Ivanov"
    },
    "url": {
        "callback_url": "https://site.com/callback",
    }
}
    

Answer is common KIPARIS payout response.

SBP

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "1000.00",
    "currency": "RUB",
    "payment_system": "SBP",
    "note": "Account deposit 321",
    "system_fields": {
        "client_id": "321"
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to SBP page. After payment completion client will be returned according the url block if present.

Attention! Redirect block can contain different "url", "method" and "params". "params" could be empty

The example of the common response:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "1000.00",
    "amount_merchant": "93.00",
    "amount_client": "1000.00",
    "currency": "RUB",
    "payment_system": "SBP",
    "redirect": {
        "url": "https://sbp.nspk.ru/payment",
        "method": "POST",
        "params": {
            "param": "value"
        }
    }
}
    

Request /bank/lists/available/{paymentSystem}/{country} request should be done before sending /deduce/create request. No additional fields is required.

KIPARIS response with bank list. Example of common response:

{
    "status":"ok",
    "data":[
        {
           "bank_id":"123",
            "name":"Bank name"
        },
    ],
}
    

Successful response:

Additional fields for /deduce/create request:

Answer is common KIPARIS payout response.

M10

Additional fields for /deposit/create request:

Additional fields for /deduce/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "100.00",
    "currency": "AZN",
    "payment_system": "M10",
    "note": "Account deposit 321",
    "system_fields": {
        "client_id": "321"
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to M10 page. After payment completion client will be returned according the url block if present.

Attention! Redirect block can contain different "url", "method" and "params". "params" could be empty.

The example of the common response:

        {
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "100.00",
    "amount_merchant": "95.00",
    "amount_client": "100.00",
    "currency": "AZN",
    "payment_system": "M10",
    "redirect": {
        "url": "https://site.url/",
        "method": "GET",
        "params": {
            "param": "value"
        }
    }
}
    

EManat

Additional fields for /deposit/create request:

Additional fields for /deduce/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "100.00",
    "currency": "AZN",
    "payment_system": "MPay",
    "note": "Account deposit 321",
    "system_fields": {
        "client_id": "321"
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to EManat page. After payment completion client will be returned according the url block if present.

Attention! Redirect block can contain different "url", "method" and "params". "params" could be empty

The example of the common response:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "100.00",
    "amount_merchant": "95.00",
    "amount_client": "100.00",
    "currency": "AZN",
    "payment_system": "MPay",
    "redirect": {
        "url": "https://site.url/",
        "method": "GET",
        "params": {
            "param": "value"
        }
    }
}
    

Applepay

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "100.00",
    "currency": "EUR",
    "system_fields": {
        "client_id" : "321",
        "client_email" : "test@test.com"
    },
    "payment_system": "ApplePay",
    "url": {
        "fail_url": "https://site.com/fail",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to KIPARIS checkout page with the ApplePay button. After checkout client will be redirected to ApplePay payment process or 3DS page and then returned according the url block.

The example of the common response:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "100.00",
    "amount_merchant": "95.00",
    "amount_client": "100.00",
    "currency": "EUR",
    "payment_system": "ApplePay",
    "redirect": {
        "url": "https://psp.kiparisdmcc.ae/payment/checkout/ap",
        "method": "GET",
        "params": {
            "data": "12345678"
        }
    }
}
    

Googlepay

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "100.00",
    "currency": "EUR",
    "payment_system": "GooglePay",
    "system_fields": {
        "client_id" : "321",
        "client_email" : "test@test.com"
    },
    "url": {
        "fail_url": "https://site.com/fail",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to KIPARIS checkout page with the GooglePay button. After checkout client will be redirected to GooglePay payment process or 3DS page and then returned according the url block.

The example of the common response:

{
    "status": "created",
    "id": "300",
    "transaction_id": "123",
    "type": "deposit",
    "amount_to_pay": "100.00",
    "amount_merchant": "95.00",
    "amount_client": "100.00",
    "currency": "EUR",
    "payment_system": "GooglePay",
    "redirect": {
        "url": "https://psp.kiparisdmcc.ae/payment/checkout/gp",
        "method": "GET",
        "params": {
            "data": "12345678"
        }
    }
}
    

Trustly

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "EUR",
    "payment_system": "Trustly",
    "note": "Account deposit 321",
    "system_fields": {
        "client_first_name": "John",
        "client_last_name": "Doe",
        "client_email": "test@test.test",
        "client_document_id": "DocumentID",
        "client_country_code": "DE",
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to Trustly page. After payment completion client will be returned according the url block if present.

Blik

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "EUR",
    "payment_system": "Blik",
    "note": "Account deposit 321",
    "system_fields": {
        "client_first_name": "John",
        "client_last_name": "Doe",
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to Blik page. After payment completion client will be returned according the url block if present.

Bancontact

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "EUR",
    "payment_system": "Bancontact",
    "note": "Account deposit 321",
    "system_fields": {
        "client_first_name": "John",
        "client_last_name": "Doe",
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to Bancontact page. After payment completion client will be returned according the url block if present.

EPS

Additional fields for /deposit/create request:

The example of the request:

{
    "transaction_id": "123",
    "amount": "10.00",
    "currency": "EUR",
    "payment_system": "EPS",
    "note": "Account deposit 321",
    "system_fields": {
        "client_first_name": "John",
        "client_last_name": "Doe",
    },
    "url": {
        "callback_url": "https://site.com/callback",
        "fail_url": "https://site.com/fail",
        "pending_url": "https://site.com/pending",
        "success_url": "https://site.com/success"
    }
}
    

Answer is common KIPARIS response with Redirect block to EPS page. After payment completion client will be returned according the url block if present.