Skip to content

Almond Settlement API (1.1.0)

The Almond Settlement API enables clients to move funds cross-border by leveraging blockchain as the transfer layer.

As a client, you need to:

  • Authenticate to obtain an access token.
  • Check Settlement Rates for transparency.
  • Create a Settlement with relevant details.

Almond then fully automates the orchestration — buying crypto, transferring it across the blockchain, swapping it into destination currency, and depositing it into the recipient's local bank account(or the account under the payout partner) — sending notifications upon successful completion.

System Flow
Figure: Settlement Flow

Download OpenAPI description
Languages
Servers
Mock server
https://docs.almondfintech.com/_mock/apis/settlements
Sandbox
https://api.sandbox.almondfintech.com
Production
https://api.almondfintech.com
Operations

Request

Retrieves the guaranteed/locked exchange rate for settlement along with forecast rates for different execution intervals.

Rate Information Includes:

  • Current Rate: locked exchange rate for immediate execution
  • Rate ID: Unique identifier of the rate
  • Forecast Rates: Forecast rates for execution at different time intervals (1-6 hours)
  • Corridor Information: Source and destination member IDs

Rate Locking:

  • Each rate response includes a rateId that locks the current rate
  • This rateId must be used when creating a settlement to guarantee the rate
  • Rate locks have an expiry time (typically 15 minutes for immediate execution)

Forecast Rates:

  • Provides rates for scheduled execution
  • Available intervals: IMMEDIATE, ONE_HOUR, TWO_HOURS, THREE_HOURS, FOUR_HOURS, FIVE_HOURS, SIX_HOURS
  • Helps members choose optimal execution timing based on rate forecasts
Query
destinationCcystring^[A-Z]{3}$required

ISO 4217 three-letter currency code for the destination currency.

Example: destinationCcy=PHP
curl -i -X GET \
  'https://docs.almondfintech.com/_mock/apis/settlements/v2/settlement-rates?destinationCcy=PHP'

Responses

Rate information

Bodyapplication/json
ratenumber(float)
rateIdstring
sourceMemberIdstring
destinationMemberIdstring
forecastRatesArray of objects(ForecastRate)
Response
application/json
{ "rate": 55.75, "rateId": "c162d93e-dfac-4d26-8da3-b3b76f8ca3e0", "sourceMemberId": "SOURCE_MEMBER", "destinationMemberId": "DEST_MEMBER_1", "forecastRates": [ {}, {}, {}, {}, {}, {}, {} ] }
Operations
Operations