### Setup SDK Example App Source: https://docs.payabli.com/developers/platform-sdk-python-guide.md Commands to clone, configure, and run the SDK example application. ```bash git clone https://github.com/payabli/examples ``` ```bash cd examples/sdk/py-sdk ``` ```bash python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate ``` ```bash pip install -r requirements.txt ``` ```bash cp .env.template .env ``` ```bash # your Payabli Private API token PAYABLI_KEY="o.Oim...Mekgjw=" # your Payabli entrypoint PAYABLI_ENTRY="41xxxxxa7e" # your Payabli Public API token PAYABLI_PUBLIC_TOKEN="o.Oim...Mekgjw=" ``` ```bash uvicorn main:app --reload ``` -------------------------------- ### Setup SDK Example Application Source: https://docs.payabli.com/developers/platform-sdk-csharp-guide.md Commands to clone, configure, and run the Payabli SDK example repository. ```bash git clone https://github.com/payabli/examples ``` ```bash cd examples/sdk/cs-sdk ``` ```bash dotnet restore ``` ```bash cp .env.template .env ``` ```bash # your Payabli Private API token PAYABLI_KEY="o.Oim...Mekgjw=" # your Payabli entrypoint PAYABLI_ENTRY="41xxxxxa7e" # your Payabli Public API token PAYABLI_PUBLIC_TOKEN="o.Oim...Mekgjw=" ``` ```bash dotnet run ``` -------------------------------- ### Install Dependencies and Run Application Source: https://docs.payabli.com/guides/pay-ops-developer-webhooks-quickstart.md Install required packages and start the local server. ```bash npm install npm start ``` ```bash pip install -r requirements.txt python main.py ``` -------------------------------- ### Install Go Dependencies Source: https://docs.payabli.com/developers/platform-sdk-go-guide.md Run this command in the Go SDK example directory to download and install necessary dependencies. ```bash go mod tidy ``` -------------------------------- ### Start the Development Server Source: https://docs.payabli.com/developers/platform-sdk-ruby-guide.md Run this command to start the local development server for the Ruby SDK example app. ```bash bundle exec ruby app.rb ``` -------------------------------- ### Clone and setup PHP SDK Source: https://docs.payabli.com/guides/pay-ops-developer-webhooks-quickstart.md Commands to initialize the PHP webhook example project. ```bash git clone https://github.com/payabli/examples.git cd examples/webhooks/php-sdk ``` ```bash cp .env.example .env ``` ```bash composer install php main.php ``` -------------------------------- ### Clone and setup Ruby SDK Source: https://docs.payabli.com/guides/pay-ops-developer-webhooks-quickstart.md Commands to initialize the Ruby webhook example project. ```bash git clone https://github.com/payabli/examples.git cd examples/webhooks/ruby-sdk ``` ```bash cp .env.example .env ``` ```bash bundle install ruby main.rb ``` -------------------------------- ### List Transfers via HTTP GET (PHP) Source: https://docs.payabli.com/developers/api-reference/query/get-list-of-transfers.md This PHP example uses Guzzle HTTP client to make a GET request for listing transfers. Make sure to install Guzzle via Composer. ```php request('GET', 'https://api-sandbox.payabli.com/api/Query/transfers/47862acd?fromRecord=0&limitRecord=20'); echo $response->getBody(); ``` -------------------------------- ### Direct HTTP GET Request to Export Transfers (PHP) Source: https://docs.payabli.com/developers/api-reference/export/export-list-of-transfers.md This PHP example uses GuzzleHttp to perform a direct HTTP GET request to export transfers. Ensure you have Guzzle installed via Composer. ```php request('GET', 'https://api-sandbox.payabli.com/api/Export/transfers/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` -------------------------------- ### Get Basic Customer Statistics (PHP) Source: https://docs.payabli.com/developers/api-reference/customer/get-basic-statistics-for-a-customer.md This PHP example utilizes GuzzleHttp to make a GET request for basic customer statistics. Ensure Guzzle is installed via Composer and replace '' with your key. ```php request('GET', 'https://api-sandbox.payabli.com/api/Statistic/customerbasic/ytd/m/998', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` -------------------------------- ### Direct HTTP GET Request for Settlements Export (PHP) Source: https://docs.payabli.com/developers/api-reference/export/export-list-of-settled-transactions-for-an-organization.md This PHP example uses GuzzleHttp to make a direct HTTP GET request for exporting settlement data. Ensure GuzzleHttp is installed via Composer. ```php request('GET', 'https://api-sandbox.payabli.com/api/Export/settlements/csv/org/123?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` -------------------------------- ### List Outbound Transfers (PHP) Source: https://docs.payabli.com/developers/api-reference/query/get-list-of-transfers-out-for-entrypoint.md A PHP example using Guzzle HTTP client to make a GET request for outbound transfers. It requires the Guzzle library to be installed via Composer. ```php request('GET', 'https://api-sandbox.payabli.com/api/Query/transfersOut/47cade237?fromRecord=0&limitRecord=20'); echo $response->getBody(); ``` -------------------------------- ### Get Line Item Details (PHP) Source: https://docs.payabli.com/developers/api-reference/lineitem/get-item-in-entrypoint.md PHP example using Guzzle HTTP client to request line item data. Ensure you have the Guzzle package installed and replace '' with your key. ```php request('GET', 'https://api-sandbox.payabli.com/api/LineItem/700', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` -------------------------------- ### Navigate to SDK Example Directory Source: https://docs.payabli.com/developers/platform-sdk-go-guide.md Change your current directory to the Go SDK example app within the cloned repository. ```bash cd examples/sdk/go-sdk ``` -------------------------------- ### Export Payout Data via HTTP GET Request (PHP) Source: https://docs.payabli.com/developers/api-reference/export/export-list-of-payouts-for-an-entrypoint.md This PHP example uses the Guzzle HTTP client to make a GET request for exporting payout data. It sets the API key in the headers and includes all necessary query parameters in the URL. Make sure to install Guzzle via Composer. ```php request('GET', 'https://api-sandbox.payabli.com/api/Export/payouts/csv/8cfec329267?columnsExport=BatchDate%3ABatch_Date%2CPaypointName%3ALegal_name&fromRecord=251&limitRecord=1000', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` -------------------------------- ### List Organization Transfers (PHP HTTP) Source: https://docs.payabli.com/developers/api-reference/query/get-list-of-transfers-for-an-organization.md This PHP example uses Guzzle HTTP client to make a direct GET request to the Payabli API for listing organization transfers. Ensure Guzzle is installed via Composer. ```php request('GET', 'https://api-sandbox.payabli.com/api/Query/transfers/org/123?fromRecord=0&limitRecord=20'); echo $response->getBody(); ``` -------------------------------- ### Initialize Project and Dependencies Source: https://docs.payabli.com/guides/pay-ops-developer-webhooks-quickstart.md Commands to create a new directory, initialize the project, and install the Express framework. ```bash mkdir webhook-example cd webhook-example npm init -y ``` ```bash npm install express ``` ```bash touch server.js ``` -------------------------------- ### Navigate to the SDK example directory Source: https://docs.payabli.com/developers/platform-sdk-rust-guide.md Change the working directory to the Rust SDK example folder. ```bash cd examples/sdk/rust-sdk ``` -------------------------------- ### List Notification Reports (PHP HTTP Request) Source: https://docs.payabli.com/developers/api-reference/notification/get-list-of-reports-generated-in-last-60-days-for-organization.md This PHP example demonstrates fetching notification reports via an HTTP GET request using the Guzzle HTTP client. Ensure the Guzzle library is installed via Composer. ```php request('GET', 'https://api-sandbox.payabli.com/api/Query/notificationReports/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` -------------------------------- ### Run Go Webhook Example Source: https://docs.payabli.com/guides/pay-ops-developer-webhooks-quickstart.md Execute the Go application to start a local HTTP server for receiving webhooks. ```bash go run . ``` -------------------------------- ### Create the index file Source: https://docs.payabli.com/developers/platform-sdk-php-guide.md Create the main entry point file for your application. ```bash touch index.php ``` -------------------------------- ### Start Development Server Source: https://docs.payabli.com/developers/platform-sdk-typescript-guide.md Launches the local development server. ```bash npm run dev ``` -------------------------------- ### Initialize Go Project Source: https://docs.payabli.com/developers/platform-sdk-go-guide.md Create a new Go project directory and initialize it as a Go module. ```bash mkdir my-payabli-app cd my-payabli-app go mod init my-payabli-app ``` -------------------------------- ### Start the development server Source: https://docs.payabli.com/developers/platform-sdk-php-guide.md Launch the local development server to access the application. ```bash composer run serve ``` -------------------------------- ### Get Organization Settings (Java) Source: https://docs.payabli.com/developers/api-reference/organization/get-organization-settings.md Example of making an HTTP GET request in Java using the Unirest library to get organization settings. The API key is set in the 'requestToken' header. ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Organization/settings/123") .header("requestToken", "") .asString(); ``` -------------------------------- ### Get Payout Details via HTTP GET (Swift) Source: https://docs.payabli.com/developers/api-reference/moneyout/get-details-for-a-processed-payout-transaction.md Retrieve payout details using Swift by making a direct HTTP GET request. This example uses URLSession for network communication. ```swift import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` -------------------------------- ### Navigate to the app directory Source: https://docs.payabli.com/guides/pay-ops-developer-boarding-quickstart.md Change your current directory to the 'boarding' example app within the cloned repository. ```bash cd examples/boarding ``` -------------------------------- ### Navigate to the application directory Source: https://docs.payabli.com/developers/platform-sdk-php-guide.md Change the working directory to the PHP SDK example folder. ```bash cd examples/sdk/php-sdk ``` -------------------------------- ### Get Payout Details via HTTP GET (Java) Source: https://docs.payabli.com/developers/api-reference/moneyout/get-details-for-a-processed-payout-transaction.md Example of fetching payout details using an HTTP GET request in Java with the Unirest library. Ensure Unirest is included in your project dependencies. ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/MoneyOut/details/45-as456777hhhhhhhhhh77777777-324") .header("requestToken", "") .asString(); ``` -------------------------------- ### Navigate to SDK Example App Directory Source: https://docs.payabli.com/developers/platform-sdk-ruby-guide.md Change your current directory to the Ruby SDK example app within the cloned repository. ```bash cd examples/sdk/ruby-sdk ``` -------------------------------- ### Get Subscription via HTTP Request Source: https://docs.payabli.com/developers/api-reference/subscription/get-subscription.md Examples for retrieving subscription details by making direct HTTP GET requests to the Payabli API endpoint. ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Subscription/263" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("requestToken", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Subscription/263") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Subscription/263") .header("requestToken", "") .asString(); ``` ```php request('GET', 'https://api-sandbox.payabli.com/api/Subscription/263', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```swift import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Subscription/263")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` -------------------------------- ### Get Notification using C# SDK Source: https://docs.payabli.com/developers/api-reference/notification/get-notification.md This C# example shows how to get a notification using the Payabli SDK. Replace 'YOUR_API_KEY_HERE' with your API key. ```csharp using PayabliPayabliApi; using System.Threading.Tasks; namespace Usage; public class Example { public async Task Do() { var client = new PayabliPayabliApiClient( apiKey: "YOUR_API_KEY_HERE" ); await client.Notification.GetNotificationAsync( "1717" ); } } ``` -------------------------------- ### Initialize .NET Project Source: https://docs.payabli.com/developers/platform-sdk-csharp-guide.md Commands to create a new .NET console application directory and project. ```bash mkdir MyPayabliApp cd MyPayabliApp dotnet new console ``` -------------------------------- ### Get Line Item Details (C#) Source: https://docs.payabli.com/developers/api-reference/lineitem/get-item-in-entrypoint.md Example using the Payabli C# SDK to get a line item. Remember to substitute 'YOUR_API_KEY_HERE' with your key. ```csharp using PayabliPayabliApi; using System.Threading.Tasks; namespace Usage; public class Example { public async Task Do() { var client = new PayabliPayabliApiClient( apiKey: "YOUR_API_KEY_HERE" ); await client.LineItem.GetItemAsync( 700 ); } } ``` -------------------------------- ### Clone the Example Repository Source: https://docs.payabli.com/developers/platform-sdk-ruby-guide.md Use this command to clone the Payabli examples repository, which contains the Ruby SDK example app. ```bash git clone https://github.com/payabli/examples ``` -------------------------------- ### Get Attached File from Invoice (Direct HTTP GET - Swift) Source: https://docs.payabli.com/developers/api-reference/invoice/get-attached-file-from-an-invoice.md Swift code example for making a direct HTTP GET request to retrieve an attached file from an invoice. This uses URLSession for the network request. ```swift import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Invoice/attachedFileFromInvoice/1/filename")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` -------------------------------- ### Create main.go file Source: https://docs.payabli.com/developers/platform-sdk-go-guide.md Create the main Go file for your application. ```bash touch main.go ``` -------------------------------- ### Start the development server Source: https://docs.payabli.com/developers/platform-sdk-java-guide.md Launch the application locally using the Maven exec plugin. ```bash mvn exec:java ``` -------------------------------- ### Get Subscription Details Source: https://docs.payabli.com/guides/pay-in-developer-subscriptions-manage.md Send a GET request to retrieve details for a specific subscription using its ID. This example retrieves details for subscription ID `263`. ```http GET /api/Subscription/263 HTTP/1.1 Host: api.payabli.com Authorization: Bearer YOUR_API_KEY ``` -------------------------------- ### Install and run the Query CLI app Source: https://docs.payabli.com/developers/platform-developer-query-cli.md Commands to clone, build, and execute the application from the source repository. ```bash git clone https://github.com/payabli/payquery-cli ``` ```bash cargo build --release ``` ```bash cargo run ``` ```bash cargo run -- transactions ``` -------------------------------- ### Get User Data with C# SDK Source: https://docs.payabli.com/developers/api-reference/user/get-user-in-an-organization.md This C# example shows how to get user data using the Payabli SDK. Replace 'YOUR_API_KEY_HERE' with your API key. ```csharp using PayabliPayabliApi; using System.Threading.Tasks; namespace Usage; public class Example { public async Task Do() { var client = new PayabliPayabliApiClient( apiKey: "YOUR_API_KEY_HERE" ); await client.User.GetUserAsync( 1000000L, new GetUserRequest { Entry = "478ae1234" } ); } } ``` -------------------------------- ### Initialize Payabli Python Client Source: https://docs.payabli.com/developers/api-reference/boarding/create-boarding-application.md Example of initializing the Payabli client and adding an application with service configurations. ```python from payabli import payabli, ApplicationDataOdp, Services, AchSetup, CardSetup, OdpSetup, FileContent, Bank, ApplicationDataOdpContactsItem, ApplicationDataOdpOwnershipItem, SignerDataRequest client = payabli( api_key="YOUR_API_KEY_HERE", ) client.boarding.add_application( request=ApplicationDataOdp( services=Services( ach=AchSetup( accept_ccd=True, accept_ppd=True, accept_web=True, ), card=CardSetup( accept_amex=True, accept_discover=True, ``` -------------------------------- ### Get Attached File from Invoice (Direct HTTP GET - Ruby) Source: https://docs.payabli.com/developers/api-reference/invoice/get-attached-file-from-an-invoice.md This Ruby example shows how to perform a direct HTTP GET request to fetch an invoice's attached file. It sets the necessary 'requestToken' header. ```ruby require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Invoice/attachedFileFromInvoice/1/filename") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` -------------------------------- ### Configure Environment Variables Source: https://docs.payabli.com/guides/pay-ops-developer-webhooks-quickstart.md Copy the example environment file to create a local configuration. ```bash cp .env.example .env ``` -------------------------------- ### Get Attached File from Invoice (Direct HTTP GET - Java) Source: https://docs.payabli.com/developers/api-reference/invoice/get-attached-file-from-an-invoice.md Example using Unirest library in Java to make a direct HTTP GET request for an invoice's attached file. Ensure the Unirest library is included. ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Invoice/attachedFileFromInvoice/1/filename") .header("requestToken", "") .asString(); ``` -------------------------------- ### List Transfers via HTTP GET (Ruby) Source: https://docs.payabli.com/developers/api-reference/query/get-list-of-transfers.md A Ruby example demonstrating how to fetch a list of transfers by making a direct HTTP GET request to the Payabli API. ```ruby require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/transfers/47862acd?fromRecord=0&limitRecord=20") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` -------------------------------- ### Clone the repository Source: https://docs.payabli.com/guides/pay-ops-developer-webhooks-quickstart.md Download the example project and navigate to the Rust SDK directory. ```bash git clone https://github.com/payabli/examples.git cd examples/webhooks/rust-sdk ``` -------------------------------- ### Run the Example App Source: https://docs.payabli.com/developers/platform-sdk-ruby-guide.md Execute this command in your terminal to run the main Ruby application file. ```bash ruby main.rb ``` -------------------------------- ### Get Organization Settings (Swift) Source: https://docs.payabli.com/developers/api-reference/organization/get-organization-settings.md Swift example for making an HTTP GET request to retrieve organization settings. The API key is passed via the 'requestToken' header. ```swift import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Organization/settings/123")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```