Introduction - Pooler Developer Documentation

Welcome

Welcome to the Pooler Developer API documentation. This API provides comprehensive payment processing, virtual accounts, foreign exchange, and financial services capabilities. The Pooler API enables you to:

Capability	Description
Process Payments	Send and receive payments across multiple currencies and countries
Manage Virtual Accounts	Create virtual accounts for collecting payments from customers
Handle Recipients	Manage payment recipients and their bank account details
Foreign Exchange	Access real-time FX rates and quotes for currency conversions
Webhooks	Receive real-time notifications about payment events
Utilities	Access tools for account verification and institution lookup

Getting Started

Base URL

Environment	URL
Production	`https://api.usepooler.com`
Sandbox	`https://studio.usepooler.com`

Authentication

All API endpoints require authentication using Bearer tokens. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

API Keys

To get your API keys:

Sign up for a Pooler account at app.usepooler.com
Navigate to the API section in your dashboard
Generate your API keys (separate keys for test and live modes)

Keep your API keys secure. Never expose them in client-side code or commit them to version control.

API Structure

The Pooler API is organized into the following main sections:

Section	Description
Business	Account management and merchant information
Payments	Payment initiation, confirmation, and status queries
Accounts	Virtual account creation and management
Recipients	Payment recipient management
Webhooks	Event management and delivery
FX	Foreign exchange rates and quotes
Utilities	Helper endpoints for verification and lookup

Response Format

All API responses follow a consistent structure:

{
  "success": true,
  "message": "Request completed successfully",
  "stan": "unique-transaction-id",
  "data": { ... }
}

Field	Description
`success`	Boolean indicating request success
`message`	Human-readable response message
`stan`	System Trace Audit Number (unique transaction identifier)
`data`	Response payload (varies by endpoint)

Error Handling

When an error occurs, the API returns an error response:

{
  "success": false,
  "message": "Error description",
  "stan": "unique-transaction-id",
  "data": "Additional error details"
}

Common HTTP status codes:

Status Code	Description
`200 OK`	Request successful
`201 Created`	Resource created successfully
`202 Accepted`	Request accepted for processing
`400 Bad Request`	Invalid request parameters
`401 Unauthorized`	Invalid or missing authentication
`404 Not Found`	Resource not found
`500 Internal Server Error`	Server error

Support

For API support and questions:

Resource	Details
Email	tech@usepooler.com
Dashboard	app.usepooler.com
Documentation	This documentation site

​Welcome

​Getting Started

​Base URL

​Authentication

​API Keys

​API Structure

​Response Format

​Error Handling

​Support

Welcome

Getting Started

Base URL

Authentication

API Keys

API Structure

Response Format

Error Handling

Support