Payments API Code Catalogue

Overview:

The Fileactive Payments API suite enables developers to handle a wide range of payment types across multiple regions, including Australia, Hong Kong, India, Singapore, and Vietnam. With robust support for domestic and international transactions, the APIs ensure secure, efficient, and reliable payment processing, utilizing OAuth 2.0 for authentication and JWT for encryption and signing.


Regional payment capabilities

  • Australia:
    NPP/OSKO Payment: Utilize the NPP API for real-time domestic payments, with instant settlements via the New Payments Platform (NPP). Secure transactions with OAuth 2.0 and JWT to protect data integrity.

    Cross Border Payment: Provide regional payment capabilities, allowing customers to process transactions across borders seamlessly and efficiently. Leverage ANZ’s global network to ensure secure and compliant cross-border payments.

  • Hong Kong:
    Support for ACH, FPS, RTGS, and CBFT payments allows for versatile payment processing needs, from automated clearing to real-time gross settlements. Each payment type comes with its dedicated status endpoints for tracking.

  • India:
    Manage ACH payments securely and efficiently, automating clearing house transactions with integrated status checks.

  • Singapore:
    The API supports ACH, FAST, RTGS, and CBFT payments, covering a broad spectrum of payment needs from rapid domestic transfers to cross-border fund transfers. Secure authentication and encryption are standard for all transactions.

  • Vietnam:
    Handle ACH payments with ease, leveraging secure API endpoints for transaction processing and status retrieval.


Key features:

  • Multi-Regional support: A single API suite to manage various payment types across Australia, Hong Kong, India, Singapore, and Vietnam.

  • Secure transactions: All payments are authenticated using OAuth 2.0, and data is protected with JWT signing and encryption.

  • Comprehensive tracking: Each payment type includes endpoints for real-time status tracking, ensuring transparency and control over financial operations.


Technical requirements:

  • OAuth 2.0 Authentication: Implement secure access control using OAuth 2.0 with signed client assertions.

  • JWT Encryption and signing: Securely transmit payment data with JWT, ensuring both integrity and confidentiality.

  • API rate limits: Be mindful of rate limits and Optimise API usage according to business needs.

Integrate Fileactive APIs into your systems to streamline payment processes, automate transactions, and enhance security across your payment workflows.

This set of diagrams shows the flows for using the Fileactive Payment API. The APIs utilize OAuth for authentication, require payments to be encrypted and signed with JWT keys, and involve sending a signed client assertion.


Common authentication flow

sequenceDiagram participant Customer participant API Gateway participant Fileactive Customer->>API Gateway: POST /v1.0/auth (OAuth Client Assertion) API Gateway->>Customer: 200 OK (Bearer Token)

Consolidated payment flows

sequenceDiagram participant Customer participant API Gateway participant Fileactive %% Payment Submission Flow Customer->>API Gateway: POST /{region}/v1.0/payment/submit (JWT Signed & Encrypted) API Gateway->>Fileactive: Forward Payment Request (JWT) Fileactive-->>API Gateway: 201 Created API Gateway-->>Customer: 201 Created (Payment Submission Confirmation) %% Payment Status Check Flow Customer->>API Gateway: GET /{region}/v1.0/payment/{transaction_id}/status API Gateway->>Fileactive: Get Payment Status Fileactive-->>API Gateway: 200 OK (Payment Status) API Gateway-->>Customer: 200 OK (Payment Status)

Regional endpoints overview:

Region Payment Method Endpoint
Australia NPP /npp/v1.0/payment/submit
Australia CBFT /payment/au/v1.0/cbft
India ACH /payment/in/v1.0/ach
Hong Kong ACH /payment/hk/v1.0/ach
Hong Kong FAST /payment/hk/v1.0/fast
Hong Kong RTGS /payment/hk/v1.0/rtgs
Hong Kong CBFT /payment/hk/v1.0/cbft
Singapore ACH /payment/sg/v1.0/ach
Singapore FAST /payment/sg/v1.0/fast
Singapore RTGS /payment/sg/v1.0/rtgs
Singapore CBFT /payment/sg/v1.0/cbft
Vietnam ACH /payment/vn/v1.0/ach

Key points for developers:

  • Consistent Flow: The payment submission and status check flows are consistent across all regions, providing a unified approach to handling various payment types.

  • Regional Variations: Only the endpoint paths change according to the specific country and payment method, ensuring a smooth adaptation to different payment infrastructures.

  • Secure Processes: All requests are secured with JWT encryption and OAuth 2.0 authentication, maintaining high standards of data protection across all transactions.