Start
Use api_token for authentication.
You can send the data to us via GET.
You must create a HASH for each API request.
Bank Deposit
# Bank Deposit Example URL
$url = 'https://api.justpaydeposit.com/api/deposit?method=$method&api_token&api_token&name=$name&surname=$surname&tc_number=$tc_number&user_id=$user_id&hash=$hash&amount=$amount&transaction_id=$transaction_id';
$transaction_id='1234560';
$name='John';
$surname='Dea';
$tc_number='12345679810';
$user_id='12300';
$hash=md5($method. $transaction_id.$user_id'.$secret_key');
$method = 'bankDeposit';
$api_token = 'Api TOKEN';
$amount = 500;
Returned Value:
hash = md5($transaction_id.$amount.$secret_key);
Statuses:
"status":"2" = The transaction has been approved.
"status":"3" = The transaction has been rejected.
If the transaction is approved, we will send you the value:
{"method":"bankDeposit","transaction_id":"1234560","hash":"7af4bf64da5153f8ef58790c4468aacc","amount":"500","status":"2"}
to your callback URL address.
If the transaction is cancelled or rejected, we will send you the value:
{"method":"bankDeposit","transaction_id":"1234560","hash":"7af4bf64da5153f8ef58790c4468aacc","amount":"500","status":"3"}
to your callback URL address.
The API address you will use for Deposit:
https://api.justpaydeposit.com/api/deposit?method=$method&api_token&api_token&name=$name&surname=$surname&tc_number=$tc_number&user_id=$user_id&hash=$hash&amount=$amount&transaction_id=$transaction_id
Parameters to Use
| Field | Type | Description |
|---|---|---|
| api_token | String | Your Api Token. |
| method | String | bankDeposit |
| amount | Number | Deposit Amount |
| transaction_id | string | Transaction ID |
| name | string | Name of the customer |
| surname | string | Surname of the customer |
| tc_number | string | Identity Number of the customer (You can send random data if you don't want to share) |
| user_id | string | User ID of the customer on the website |
| hash | string | A variable that we will use for encryption. Example: $hash = md5($method. $transaction_id.$user_id'. $secret_key'); |
Withdrawal Usage
# EXAMPLE OF WITHDRAWAL PROCESS
$url = 'https://api.justpays.co/api/cekim?api_token={your_api_token}';
$method = 'bankWithdraw';
$transaction_id = 2022;
$user_id = 1144;
$name_surname = 'John Doe';
$bank_name = 'Ziraat Bankası';
$branch_code = '59005';
$account_number = '597840455';
$iban = 'TR990051506045781059201560';
$amount = 500;
$tc_number = '1212121212';
$note = 'notes';
$tel_no = '05055055000';
$secret_key = 'YOUR SECRET KEY';
$hash=md5($method . $transaction_id . $user_id . $secret_key)
Returned Value:
{"code":200,"message":"Success"}
CALBACK HASH FORMAT : hash = md5($transaction_id.$amount.$secret_key);
The API address you will use for withdrawals:
https://api.justpays.co/api/cekim?api_token={your_api_token}
The Parameters You Will Use
| Field | Type | Description |
|---|---|---|
| secret_key | String | Your SECRET KEY. |
| method | String | bankWithdraw |
| transaction_id | Number | Transaction ID of customer side |
| user_id | Number | User ID of customer side |
| name_surname | String | Name Surname of your user |
| bank_name | String | Name of the bank |
| branch_code | String | Branch code of the bank |
| account_number | String | Bank account number |
| iban | String | User IBAN number |
| amount | Number | Withdrawal amount |
| tc_number | String | User TC number |
| tel_no | String | User phone number |
| note | String | (Optional) Note from the customer. |
| hash | String | md5($method.$transaction_id.$user_id.$secret_key) |
Errors
Possible Errors You May Encounter:
Error Returned Values :
{"code":403,"message":"Unauthorized Access!"}
{"code":406,"message":"Incorrect Submission"}
{"code":409,"message":"Incorrect Submission"}
{"code":479,"message":"Transaction ID Error"}
{"code":400,"message":"System Error"}
{"code":906,"message":"Incorrect Operation!"}
{"code":999,"message":"System Closed!"}
| Error Code | Description |
|---|---|
| 403 | One of your API Key or Secret Keys is wrong. |
| 406 | There is a missing or empty value in the submitted request (except for note). |
| 409 | The Hash Code is incorrect. |
| 400 | System error. |
| 906 | Incorrect operation. |
| 999 | System is closed. |
Callback Requests
Examples of callback requests we will send to the URL you provide, along with status values and hash descriptions:
Bank Deposit Example:
If the transaction is approved, we will send you the value:
{"method":"bankDeposit","transaction_id":"1234560","hash":"7af4bf64da5153f8ef58790c4468aacc","amount":"500","status":"2"}
to your callback URL address.
If the transaction is cancelled or rejected, we will send you the value:
{"method":"bankDeposit","transaction_id":"1234560","hash":"7af4bf64da5153f8ef58790c4468aacc","amount":"500","status":"3"}
to your callback URL address.
Withdrawal Example:
If the transaction is approved, we will send you the value:
{"method":"bankWithdraw","transaction_id":"1234560","hash":"7af4bf64da5153f8ef58790c4468aacc","amount":"500","status":"2"}
to your callback URL address.
If the transaction is cancelled or rejected, we will send you the value:
{"method":"bankWithdraw","transaction_id":"1234560","hash":"7af4bf64da5153f8ef58790c4468aacc","amount":"500","status":"3"}
to your callback URL address.
| Status Code | Description |
|---|---|
| 1 | The transaction has been received and is pending. |
| 2 | The transaction has been approved. |
| 3 | The transaction has been rejected. |