Skip to content

Latest commit

 

History

History
232 lines (130 loc) · 6.64 KB

WalletsApi.md

File metadata and controls

232 lines (130 loc) · 6.64 KB

\WalletsApi

All URIs are relative to https://api.getlago.com/api/v1

Method HTTP request Description
create_wallet POST /wallets Create a new wallet
create_wallet_transaction POST /wallet_transactions Create a new wallet transaction
destroy_wallet DELETE /wallets/{id} Delete a wallet
find_all_wallet_transactions GET /wallets/{id}/wallet_transactions Find wallet transactions
find_all_wallets GET /wallets Find wallets
find_wallet GET /wallets/{id} Find wallet
update_wallet PUT /wallets/{id} Update an existing wallet

create_wallet

crate::models::Wallet create_wallet(wallet_input) Create a new wallet

Create a new wallet

Parameters

Name Type Description Required Notes
wallet_input WalletInput Wallet payload [required]

Return type

crate::models::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]

create_wallet_transaction

crate::models::WalletTransactions create_wallet_transaction(wallet_transaction_input) Create a new wallet transaction

Create a new wallet transaction

Parameters

Name Type Description Required Notes
wallet_transaction_input WalletTransactionInput Wallet transaction payload [required]

Return type

crate::models::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]

destroy_wallet

crate::models::Wallet destroy_wallet(id) Delete a wallet

Delete a wallet

Parameters

Name Type Description Required Notes
id uuid::Uuid Lago ID of the existing wallet [required]

Return type

crate::models::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]

find_all_wallet_transactions

crate::models::WalletTransactionsPaginated find_all_wallet_transactions(id, page, per_page, status, transaction_type) Find wallet transactions

Find all wallet transactions for certain wallet

Parameters

Name Type Description Required Notes
id uuid::Uuid Lago ID of the existing wallet [required]
page Option<i32> Number of page
per_page Option<i32> Number of records per page
status Option<String> Status (pending or settled)
transaction_type Option<String> Transaction Type (inbound or outbound)

Return type

crate::models::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]

find_all_wallets

crate::models::WalletsPaginated find_all_wallets(external_customer_id, page, per_page) Find wallets

Find all wallets for certain customer

Parameters

Name Type Description Required Notes
external_customer_id String External customer ID [required]
page Option<i32> Number of page
per_page Option<i32> Number of records per page

Return type

crate::models::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]

find_wallet

crate::models::Wallet find_wallet(id) Find wallet

Return a wallet

Parameters

Name Type Description Required Notes
id uuid::Uuid Lago ID of the existing wallet [required]

Return type

crate::models::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]

update_wallet

crate::models::Wallet update_wallet(id, wallet_update_input) Update an existing wallet

Update an existing wallet

Parameters

Name Type Description Required Notes
id uuid::Uuid Lago ID of the existing wallet [required]
wallet_update_input WalletUpdateInput Update an existing wallet [required]

Return type

crate::models::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]