OpenAPI\Client\WalletsApi

All URIs are relative to https://api.getlago.com/api/v1, except if the operation defines another base path.

Method	HTTP request	Description
createWallet()	POST /wallets	Create a new wallet
createWalletTransaction()	POST /wallet_transactions	Create a new wallet transaction
destroyWallet()	DELETE /wallets/{id}	Delete a wallet
findAllWalletTransactions()	GET /wallets/{id}/wallet_transactions	Find wallet transactions
findAllWallets()	GET /wallets	Find wallets
findWallet()	GET /wallets/{id}	Find wallet
updateWallet()	PUT /wallets/{id}	Update an existing wallet

`createWallet()`

createWallet($wallet_input): \OpenAPI\Client\Model\Wallet

Create a new wallet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\WalletsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$wallet_input = new \OpenAPI\Client\Model\WalletInput(); // \OpenAPI\Client\Model\WalletInput | Wallet payload

try {
    $result = $apiInstance->createWallet($wallet_input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WalletsApi->createWallet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
wallet_input	\OpenAPI\Client\Model\WalletInput	Wallet payload

Return type

\OpenAPI\Client\Model\Wallet

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createWalletTransaction()`

createWalletTransaction($wallet_transaction_input): \OpenAPI\Client\Model\WalletTransactions

Create a new wallet transaction

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\WalletsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$wallet_transaction_input = new \OpenAPI\Client\Model\WalletTransactionInput(); // \OpenAPI\Client\Model\WalletTransactionInput | Wallet transaction payload

try {
    $result = $apiInstance->createWalletTransaction($wallet_transaction_input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WalletsApi->createWalletTransaction: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
wallet_transaction_input	\OpenAPI\Client\Model\WalletTransactionInput	Wallet transaction payload

Return type

\OpenAPI\Client\Model\WalletTransactions

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`destroyWallet()`

destroyWallet($id): \OpenAPI\Client\Model\Wallet

Delete a wallet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\WalletsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 1a901a90-1a90-1a90-1a90-1a901a901a90; // string | Lago ID of the existing wallet

try {
    $result = $apiInstance->destroyWallet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WalletsApi->destroyWallet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Lago ID of the existing wallet

Return type

\OpenAPI\Client\Model\Wallet

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findAllWalletTransactions()`

findAllWalletTransactions($id, $page, $per_page, $status, $transaction_type): \OpenAPI\Client\Model\WalletTransactionsPaginated

Find wallet transactions

Find all wallet transactions for certain wallet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\WalletsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 1a901a90-1a90-1a90-1a90-1a901a901a90; // string | Lago ID of the existing wallet
$page = 2; // int | Number of page
$per_page = 20; // int | Number of records per page
$status = pending; // string | Status (pending or settled)
$transaction_type = inbound; // string | Transaction Type (inbound or outbound)

try {
    $result = $apiInstance->findAllWalletTransactions($id, $page, $per_page, $status, $transaction_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WalletsApi->findAllWalletTransactions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Lago ID of the existing wallet
page	int	Number of page	[optional]
per_page	int	Number of records per page	[optional]
status	string	Status (pending or settled)	[optional]
transaction_type	string	Transaction Type (inbound or outbound)	[optional]

Return type

\OpenAPI\Client\Model\WalletTransactionsPaginated

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findAllWallets()`

findAllWallets($external_customer_id, $page, $per_page): \OpenAPI\Client\Model\WalletsPaginated

Find wallets

Find all wallets for certain customer

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\WalletsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$external_customer_id = 12345; // string | External customer ID
$page = 2; // int | Number of page
$per_page = 20; // int | Number of records per page

try {
    $result = $apiInstance->findAllWallets($external_customer_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WalletsApi->findAllWallets: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
external_customer_id	string	External customer ID
page	int	Number of page	[optional]
per_page	int	Number of records per page	[optional]

Return type

\OpenAPI\Client\Model\WalletsPaginated

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findWallet()`

findWallet($id): \OpenAPI\Client\Model\Wallet

Find wallet

Return a wallet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\WalletsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 1a901a90-1a90-1a90-1a90-1a901a901a90; // string | Lago ID of the existing wallet

try {
    $result = $apiInstance->findWallet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WalletsApi->findWallet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Lago ID of the existing wallet

Return type

\OpenAPI\Client\Model\Wallet

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateWallet()`

updateWallet($id, $wallet_update_input): \OpenAPI\Client\Model\Wallet

Update an existing wallet

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\WalletsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 1a901a90-1a90-1a90-1a90-1a901a901a90; // string | Lago ID of the existing wallet
$wallet_update_input = new \OpenAPI\Client\Model\WalletUpdateInput(); // \OpenAPI\Client\Model\WalletUpdateInput | Update an existing wallet

try {
    $result = $apiInstance->updateWallet($id, $wallet_update_input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WalletsApi->updateWallet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	Lago ID of the existing wallet
wallet_update_input	\OpenAPI\Client\Model\WalletUpdateInput	Update an existing wallet

Return type

\OpenAPI\Client\Model\Wallet

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

WalletsApi.md

Latest commit

History

WalletsApi.md

File metadata and controls

OpenAPI\Client\WalletsApi

createWallet()

Example

Parameters

Return type

Authorization

HTTP request headers

createWalletTransaction()

Example

Parameters

Return type

Authorization

HTTP request headers

destroyWallet()

Example

Parameters

Return type

Authorization

HTTP request headers

findAllWalletTransactions()

Example

Parameters

Return type

Authorization

HTTP request headers

findAllWallets()

Example

Parameters

Return type

Authorization

HTTP request headers

findWallet()

Example

Parameters

Return type

Authorization

HTTP request headers

updateWallet()

Example

Parameters

Return type

Authorization

HTTP request headers

`createWallet()`

`createWalletTransaction()`

`destroyWallet()`

`findAllWalletTransactions()`

`findAllWallets()`

`findWallet()`

`updateWallet()`