All notable changes to the API documentation are documented here.
August 2024
- Added the
Issue Interledger Wallet Address to a User
endpoint which allows the issuance of Interledger Wallet Addresses to users through theiruserID
andilpUsername
- We’ve introduced
walletID
as an optional parameter when initiating a payment request.
August 2024
Swagger Documentation Update:
-
We updated the Redeem Gift Card endpoint by adding a detailed schema under
redeemOptions
. This schema now explicitly listsemail
,countryCode
, andproductId
as properties, each with corresponding types and example values, to provide you with better clarity. We also defined thechiRef
andredeemOptions
as required fields. -
We removed redundant
email
andphoneNumber
fields from the Multi-currency wallets transfer endpoint request schema. The transfer process now prioritizes thereceiver
field, which accepts a valid Chimoney Multi-currency Account, User, or Organization ID, while retaining key fields likeoriginCurrency
,receiver
, anddestinationCurrency
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 theuserID
,linkCode
, andp_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