API Documentation

Developer Documentation

Everything you need to integrate banking functionality into your applications. Get started in minutes with our comprehensive API reference.

Get API Keys Try in Sandbox

Quick Start

Get up and running with the apibank.cloud API in just a few steps.

1. Get API Keys

2. Authenticate

Include your API key in the Authorization header of your requests.

3. Make Requests

Start making API calls to create accounts, process payments, and more.

Authentication

All API requests must include your API key in the Authorization header.

curl

curl -X GET https://api.apibank.cloud/v1/accounts \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json"

API Reference

Comprehensive reference for all available endpoints and operations.

POST

Create Account

Create a new customer account with KYC verification.

Endpoint

POST /v1/accounts

Request Body

json

{
  "customer_id": "cust_123456789",
  "account_type": "checking",
  "currency": "USD",
  "initial_deposit": 1000.00,
  "metadata": {
    "purpose": "primary_checking"
  }
}

Response

json

{
  "id": "acc_987654321",
  "customer_id": "cust_123456789",
  "account_type": "checking",
  "currency": "USD",
  "balance": 1000.00,
  "status": "active",
  "created_at": "2024-01-15T10:30:00Z",
  "account_number": "1234567890",
  "routing_number": "021000021"
}

GET

Get Account

Retrieve account details and current balance.

Endpoint

GET /v1/accounts/{account_id}

Example Request

curl

curl -X GET https://api.apibank.cloud/v1/accounts/acc_987654321 \
  -H "Authorization: Bearer your_api_key_here"

Response

json

{
  "id": "acc_987654321",
  "customer_id": "cust_123456789",
  "account_type": "checking",
  "currency": "USD",
  "balance": 1250.00,
  "available_balance": 1250.00,
  "status": "active",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-16T14:22:00Z"
}

Error Handling

Understanding API error responses and how to handle them.

HTTP Status Codes

Standard HTTP status codes used by the API.

200Success

201Created

400Bad Request

401Unauthorized

403Forbidden

404Not Found

429Rate Limited

500Internal Server Error

Error Response Format

All errors return a consistent JSON structure.

json

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_funds",
    "message": "The account has insufficient funds for this transaction",
    "param": "amount",
    "request_id": "req_123456789"
  }
}

Rate Limiting

API rate limits and best practices for handling them.

Rate Limits by Plan

Free Tier:100 requests/minute

Professional:1,000 requests/minute

Enterprise:Custom limits

Rate Limit Headers

X-RateLimit-Limit

X-RateLimit-Remaining

X-RateLimit-Reset