Initiating pay out

Pay out with unsaved card

Creating a withdrawal transaction

POST https://prapi.tarlanpayments.kz/transaction/api/v1/transaction/primal/pay-out

Headers

Name	Type	Description
Authorization*	String	Bearer Auto-rotation hash (see Signature Creating)

Request Body

Name	Type	Description
amount*	Float	Amount of payment
project_client_id	String	Client ID on the project side
callback_url	String	Project URL for sending callback with transaction status (see Sending callback)
failure_redirect_url	String	Project page to which the user will be redirected after unsuccessful payment. If the value parameter was not uploaded, the redirect will be performed to success_redirect_url
merchant_id*	Integer	Merchant ID assigned by the payment system
project_id*	Integer	Project ID assigned by the payment system
project_reference_id*	String	Order number on the project side
success_redirect_url*	String	Project page to which the user will be redirected after successful payment
shipment	String	Shipping address
confirm_url	String	Project URL for payment confirmation (see Payment Confirmation)
description*	String	Description of payment
additional_data	Object	More Options

200: OK Example of a successful response

{
    "status": true,
    "message": "Success",
    "result": "https://process-dev.tarlanpayments.kz?hash=$2a$10$nhrUYWm9sDVYqCL4LKxn9ugrdC4Pszz5wGaUsDYYIqCGc8ZA4Vu0y&transaction_id=100474"
}

500: Internal Server Error Example of an error response

{
    "status": false,
    "status_code": 5000,
    "message": "transaction already exists",
    "result": {}
}

Example of a CURL request:

curl --location 'https://prapi.tarlanpayments.kz/transaction/api/v1/transaction/primal/pay-out' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer sign' \
--data-raw '{
    "amount": 10,
    "callback_url": "https://test.site/callback_url",
    "confirm_url": "",
    "description": "999",
    "failure_redirect_url": "https://www.test.com",
    "merchant_id": 9999,
    "project_client_id": "999",
    "project_id": 9999,
    "project_reference_id": "999",
    "shipment": "",
    "success_redirect_url": "https://www.test.com",
    "additional_data": {
        "test1": "value1",
        "test2": 2
    }
}'

Withdrawal of funds to a saved card

When passing the project_client_id parameter, the user will be able to save the card on the payment form. To save the card, the user should click "save card" on the payment form and make a successful withdrawal on this card.

For further payments on the saved card it is necessary to pass the parameter project_client_id.