API Reference

Changelog

All notable changes to the API documentation are documented here.

August 2024

  • Added the Issue Interledger Wallet Address to a Userendpoint which allows the issuance of Interledger Wallet Addresses to users through their userID and ilpUsername
  • 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 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


May 2024


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