The Hong Kong ACH (Automated Clearing House) Payments API provides a streamlined and secure way for businesses to initiate and manage domestic low-value payments in Hong Kong. This API is designed to facilitate automated, efficient, and scalable payment processing, making it an ideal solution for recurring payments, payroll, and bulk transactions.

Capabilities

  • Payment initiation: Submit ACH payment requests to transfer funds between accounts within Hong Kong.
  • Batch processing: Support for bulk payment processing, allowing multiple transactions in a single request.
  • Payment tracking: Monitor the status of payments in real-time to ensure transparency and accountability.
  • Secure transactions: All transactions are encrypted and securely transmitted, meeting regulatory and compliance standards.

Technical requirements

  • Authentication: OAuth 2.0 with the Client Credential Grant flow is used for secure access. Obtain a bearer token from the /v1.0/auth endpoint and include it in the authorisation header as Bearer <access_token>.
  • API Endpoint: All ACH payment requests should be sent to the /payment/hk/v1.0/ach endpoint.
  • Headers: Include the required headers such as Content-Type: application/json and authorisation: Bearer <access_token>.
  • Payload Format: Payment requests should be formatted in JSON, adhering to the defined schema for ACH payments.

Key features for developers

  • Automated payments: Simplifies the process of making regular payments, such as payroll or vendor payments, through automation.
  • Batch support: Efficiently handle large volumes of transactions with batch processing capabilities, reducing the need for individual requests.
  • Real-TimesStatus updates: Access up-to-date information on payment statuses, helping to manage and reconcile transactions effectively.
  • Error handling: Detailed error codes and messages assist in troubleshooting and ensuring smooth integration with your systems.

Example workflow

sequenceDiagram participant Client participant Fileactive Client->>Fileactive: POST /v1.0/auth (Obtain Bearer Token) Fileactive-->>Client: 200 OK (Bearer Token) Client->>Fileactive: POST /payment/hk/v1.0/ach (Submit ACH Payment) Fileactive-->>Client: 202 Accepted (Payment Processing) Client->>Fileactive: GET /payment/hk/v1.0/ach/{paymentId} (Check Payment Status) alt Payment Completed Fileactive-->>Client: 200 OK (Payment Success) else Payment Pending Fileactive-->>Client: 202 Accepted (Payment Pending) else Payment Failed Fileactive-->>Client: 400 Bad Request (Payment Failed) end