PHP SDK
Learn how to use our SDK in PHP to facilitate even further the integration with our Deposits APIs
Introduction
The Deposits PHP SDK (Software Development Kit) is a software package you can download and add to your existing code facilitating the integration by having pre-defined classes and functions you can call to integrate the Deposits Endpoints.
Installation
Requirements
- PHP 5.6 or later
Install
Via Composer
Install PHP SDK via Composer
1
composer require directa24/cashin-php-sdk
2
Copied!
Usage
Begin by initializing your credentials
Deposit Credentials
1
$x_login = "fUEhPEKrUt";
2
$api_key = "lTMZgRTakW";
3
$secret_key = "wSHTfsMMdNskTppilncuZPEklgLmdUAOg";
4
5
$directa24 = Directa24::getInstance($x_login, $api_key, $secret_key);
Copied!
Make sure you have whitelisted your servers IPs on our Merchant Panel by going to Settings -> API Access.
Once the credentials and the IPs have been properly set-up, you are ready to start using the classes the SDK provides. Each Class can be used to execute the functionalities of its respective Deposit Endpoint.
Make sure you take a look at the Deposit Endpoints here to review how the integration of each of them works, the validations and the responses formats.
As soon as you are ready with the integration and you have the production credentials, replace the credentials with the production ones and set the ProductionMode to True to use the production endpoints.
Set Production Mode to True
1
Directa24::setProductionMode(true);
2
Copied!
Classes
Check the respective Endpoint Page to see the format of the responses, fields requirements and validations.
Create Deposit
Every time you need to create a deposit, you will need to invoke the
CreateDepositRequest Class with all the objects containing the information required to be sent. The amount of information required depends on the flow you have chosen, either the Hosted Checkout Experience or the ONE SHOT Experience.Hosted Checkout Experience
1
$create_deposit_request = new CreateDepositRequest();
2
$create_deposit_request->invoice_id = Helpers::generateRandomString(8);
3
$create_deposit_request->amount = 100;
4
$create_deposit_request->country = "BR";
5
$create_deposit_request->currency = "BRL";
6
$create_deposit_request->language = "en";
7
8
try {
9
$response = $directa24->createDeposit($create_deposit_request);
10
11
if ($response->checkout_type === 'HOSTED') {
12
$redirect_url = $response->redirect_url;
13
$response->deposit_id;
14
$response->user_id;
15
$response->merchant_invoice_id;
16
header('Location: '. $redirect_url);
17
}
18
echo json_encode($response);
19
} catch (Directa24Exception $ex){
20
echo $ex;
21
}
Copied!
ONE SHOT Experience
1
$address = new Address();
2
$address->street = "Rua Dr. Franco Ribeiro, 52";
3
$address->city = "Rio Branco";
4
$address->state = "AC";
5
$address->zip_code = "11600-234";
6
7
8
$payer = new Payer();
9
$payer->id = "4-9934519";
10
$payer->address = $address;
11
$payer->document = "72697858059";
12
$payer->document_type = "CPF";
13
$payer->email = "[email protected]";
14
$payer->first_name = "Ricardo";
15
$payer->last_name = "Carlos";
16
$payer->phone = "+598 99730878";
17
18
19
$bank_account = new BankAccount();
20
$bank_account->bank_code = "01";
21
$bank_account->account_number = "3242342";
22
$bank_account->account_type = "SAVING";
23
$bank_account->beneficiary = "Ricardo Carlos";
24
$bank_account->branch = "12";
25
26
27
$create_deposit_request = new CreateDepositRequest();
28
$create_deposit_request->invoice_id = Helpers::generateRandomString(8);
29
$create_deposit_request->amount = 100;
30
$create_deposit_request->country = "BR";
31
$create_deposit_request->currency = "BRL";
32
$create_deposit_request->language = "en";
33
$create_deposit_request->payer = $payer;
34
$create_deposit_request->payment_method = "BB";
35
$create_deposit_request->bank_account = $bank_account;
36
$create_deposit_request->early_release = false;
37
$create_deposit_request->fee_on_payer = false;
38
$create_deposit_request->surcharge_on_payer = false;
39
$create_deposit_request->bonus_amount = 0.1;
40
$create_deposit_request->bonus_relative = false;
41
$create_deposit_request->strikethrough_price = 0.1;
42
$create_deposit_request->description = "Test";
43
$create_deposit_request->client_ip = "186.51.171.84";
44
$create_deposit_request->device_id = "00000000-00000000-01234567-89ABCDEF";
45
$create_deposit_request->back_url = "https://yoursite.com/deposit/108/cancel";
46
$create_deposit_request->success_url = "https://yoursite.com/deposit/108/confirm";
47
$create_deposit_request->error_url = "https://yoursite.com/deposit/108/error";
48
$create_deposit_request->notification_url = "https://yoursite.com/ipn";
49
$create_deposit_request->test = true;
50
$create_deposit_request->mobile = false;
51
52
try {
53
$response = $directa24->createDeposit($create_deposit_request);
54
55
if ($response->checkout_type === 'ONE_SHOT') {
56
$payment_info = $response->payment_info;
57
58
if ($payment_info->type === 'CREDIT_CARD') {
59
header('Location: ' . $response->redirect_url);
60
}
61
62
// Referenced transfer
63
if ($payment_info->type === 'BANK_TRANSFER') {
64
header('Location: ' . $response->redirect_url);
65
}
66
67
// Bank deposit
68
if ($payment_info->type === 'BANK_DEPOSIT') {
69
echo '<pre>';
70
print_r($payment_info->metadata);
71
echo '</pre>';
72
}
73
74
// Several types of payment methods: Boleto, Picpay, Oxxo
75
if ($payment_info->type === 'VOUCHER') {
76
$metadata = $payment_info->metada;
77
if (isset($metadata->qr_code)) {
78
echo '<img src="' . $metadata->qr_code . '"/>';
79
} else if (isset($metadata->digital_line) || isset($metadata->barcode)) {
80
echo '<pre>';
81
print_r($metadata);
82
echo '</pre>';
83
}
84
}
85
}
86
87
} catch (\Directa24Exception $ex) {
88
echo $ex;
89
}
Copied!
The amount and the country are the only mandatory fields for a successful request. The rest of the fields needs to be sent depending on the flow you have chosen as those will be collected by us if not sent.
Deposit Status
As soon as the deposit is created and you have received the notification in your
notification_url, you will want to retrieve the status of the deposit.1
$depositId = 300533668;
2
$directa24->depositStatus($depositId);
Copied!
Make sure you are adding the deposit_id received on your notification_url in the field depositId.
Payment Methods
For the best user experience, we recommend integrating our Payment Methods Endpoint to automatically retrieve the list of payment methods name, logos, types and more that your account has available.
In order to do that, invoke the
PaymentMethodRequest Class containing the Country's ISO code of the country you need the payment methods from in the field PaymentMethodRequest.country1
$data = $this->directa24->paymentMethods('BR');
2
foreach ($data as $paymentMethodResponse) {
3
$paymentMethodResponse->country;
4
}
Copied!
Exchange Rates
If you need to know the Exchange Rate of a given currency, you can do so by invoking
ExchangeRateRequest with the Country's ISO code of the origin and the amount you want to convert to USD.1
$amount_in_dollars = 100;
2
$country = 'BR';
3
$data = $this->directa24->currencyExchange($country, $amount_in_dollars);
Copied!
Create Refund
In order to create a refund, you need to send the deposit_id, merchant_invoice_id, and the bank_account object (only for non-cc payments, otherwise, it is optional).
1
$bank_account = new BankAccount();
2
$bank_account->bank_code = "01";
3
$bank_account->account_number = "3242342";
4
$bank_account->account_type = "SAVING";
5
$bank_account->beneficiary = "Ricardo Carlos";
6
$bank_account->branch = "12";
7
8
9
$create_refund_request = new CreateRefundRequest();
10
$create_refund_request->deposit_id = 300533180;
11
$create_refund_request->invoice_id = 'MP_b451645f30b8415ba833d37f3fa21209';
12
$create_refund_request->amount = 1;
13
$create_refund_request->bank_account = $bank_account;
14
$create_refund_request->comments = 'test';
15
$create_refund_request->notification_url = "https://yoursite.com/deposit/108/confirm";
16
17
18
$directa24 = Directa24::getInstance("fUEhPEKrUt", "lTMZgRTakW", "wSHTfsMMdNskTppilncuZPEklgLmdUAOg");
19
20
try {
21
$refund_id = $directa24->refund($create_refund_request);
22
echo $refund_id;
23
} catch (\Directa24Exception $ex) {
24
echo $ex;
25
}
Copied!
Refund Status
1
$refundId = 168250;
2
$directa24->refundStatus($refundId);
Copied!
Last modified 1yr ago