IBAN Overview
Introduction
The IBAN (International Bank Account Number) API provides a comprehensive set of endpoints for managing international recipients, merchants, and file uploads. This API enables seamless integration with the Ahrvo payment gateway for cross-border transactions.
Features
- Recipient Management: Create and manage international payment recipients
- Merchant Management: Create customer accounts for merchant operations
- File Upload: Upload documents and supporting files
- Authentication: Secure token-based authentication
Authentication
All API requests require authentication using a Bearer token. Obtain your access token using the Authentication endpoint with your app_id and app_secret.
Base URL
Production: https://api.ahrvo.network
Test: https://gateway.ahrvo.network
Common Headers
| Header | Value | Required | Description |
|---|---|---|---|
Authorization | Bearer {token} | Yes | Authentication token |
Content-Type | application/json | Yes | Request content type |
Accept | application/json | Yes | Response content type |
Getting Started
- Obtain Authentication Token: Use the Authentication endpoint to get your access token
- Create Merchant Account: Set up a customer account using your credentials
- Upload Documents: Upload any required verification documents
- Create Recipients: Add payment recipients with their banking details
- Process Payments: Execute international transfers to your recipients
API Endpoints
Authentication
- Authentication - Get access token
Customer Management
- Create Merchant - Create customer account
- Submit KYC - Submit KYC information
- Query KYC - Check KYC status
Virtual Accounts
- Apply for Virtual Account - Apply for a new virtual account
- List Virtual Accounts - Get all virtual accounts
- Close Virtual Account - Close an existing virtual account
Recipients
- Create Recipient - Add payment recipient
- Update Recipient - Update recipient details
- Query Recipient - Get recipient information
Payments
- Create Payment - Make a payment
- Query Payment - Check payment status
File Management
- File Upload - Upload documents
Support
For API support and questions, please contact the support team.