Changelog

All notable changes to the API documentation are documented here.

February 2025

New Route: Beneficiary Route
Added endpoints for managing beneficiaries:

• List Account Beneficiaries: GET /v0.2.4/beneficiary retrieves the beneficiaries associated with a specific account.
• Create Bank Beneficiary: POST /v0.2.4/beneficiary/bank creates a new bank beneficiary.

New Endpoints in Info Route
Added new endpoints to the Info route:

• Get Country States/Regions: GET /v0.2.4/info/country-states-regions get list of states/regions for a specific country.
• Bank Search: GET /v0.2.4/info/bank-search search for banks in a specific country (Supported for international banks).
• Get Beneficiaries Rules: GET /v0.2.4/info/beneficiary-rules/{countryCode} get beneficiary validation rules for a specific country.

August 2024

API Error Handling and Consistent Response Formatting
We introduced new error handling features, as well as consistent response formatting for all API endpoints. This includes:

• Error Types: Added several new Error Types such as AIRTIME_ERROR, AUTHENTICATION_ERROR, AUTHORIZATION_ERROR, BANK_ERROR and more to better categorize and manage errors.
• Error Codes: New Error codes were introduced to identify specific error scenarios, This includes: AIRTIME_NOT_SUPPORTED, ALREADY_MEMBER, APPROVAL_REQUIRED, BANK_ACCOUNT_NOT_FOUND, BANK_LOOKUP_FAILED, CURRENCY_NOT_FOUND, DELETION_NOT_ALLOWED, DUPLICATE_ENTRY.
• Response Formatting: The ResponseHandler class introduce provides standardized methods for sending success and error responses, ensuring a uniform structure across all API endpoints.
• Status Codes: Each error type has a corresponding HTTP status code, which ensures appropriate client responses for each error condition.

Swagger Documentation Update:

• We updated the Redeem Gift Card endpoint by adding a detailed schema under redeemOptions. This schema now explicitly lists email, countryCode, and productId as properties, each with corresponding types and example values, to provide you with better clarity. We also defined the chiRef and redeemOptions as required fields.

• We removed redundant email and phoneNumber fields from the Multi-currency wallets transfer endpoint request schema. The transfer process now prioritizes the receiver field, which accepts a valid Chimoney Multi-currency Account, User, or Organization ID, while retaining key fields like originCurrency, receiver, and destinationCurrency to streamline your transfer experience.

• We also removed the subAccount field from the request schema in the Get Public Profile of a Chimoney User endpoint but maintained the userID, linkCode, and p_id fields to ensure clear and precise account identification.

June & July 2024

• Included Get Community Members endpoint for retrieving all community members via Community ID.
• You can now search for Payee/Merchant information and integrate Canadian bill payments into your applications via the Payout Canadian Bill Payment endpoint.
• Added flexibility to the Canadian bills payment endpoint to support USD/CAD with the optional debitCurrency parameter and removed the valueInUSD limitation in Swagger docs.

May 2024

• Modified MultiCurrencyWallets transfer endpoint to include a narration field in the request body.
• Added a new endpoint /v0.2/sub-account/community/members to fetch community members on swagger docs.
• Modified the Swagger documentation to include the startAfterId parameter description for fetching community members.
• Added the "paid" status to the list of accepted statuses in the /v0.2/payment/simulate endpoint.

April 2024

• Updated the description object under Chimoney's Payload in payout Chimoney endpoint to accept an empty value.
• You can now fetch Chimoney transactions using their unique transaction IDs (t_id) alongside the existing method of fetching transactions by their issue IDs (issueID).

November 2023

Payout to Interledger Wallet Address

• Updated Payouts endpoint to allow testing and sending of Chimoney to an Interledger Payment Pointer/Address