API docs by Redocly

Chimoney API Reference (0.2.4)

Download OpenAPI specification:

Minimal OpenAPI 3.0 spec documenting a few Chimoney endpoints used in the project. Notes:

  • Use your API key in the request header (X-API-KEY).

Payouts

send a payment to email or phone

Sends a Chimoney payout to the specified email or phone number.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "chimoneys": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "count": 1,
  • "data": [
    ]
}

Redeem

Redeem a Chimoney as a gift card

Redeems a Chimoney transaction into a gift card.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
email
required
string <email>
countryCode
required
string

ISO 2-letter country code

productId
required
string

Gift card product/key

chiRef
required
string

Chimoney transaction reference (issueID)

Responses

Request samples

Content type
application/json
{
  • "email": "recipient@example.com",
  • "countryCode": "US",
  • "productId": "amazon",
  • "chiRef": "iss_abc123"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "redemptionRef": "redeem_123",
  • "productId": "amazon",
  • "countryCode": "US"
}

Wallets

list multicurrency wallets

Retrieves a list of all multicurrency wallets associated with an account

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "wallets": [
    ]
}