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
Operations

Request

Retrieves settlement context information, providing an overview of available settlement corridors and their current capacity.

This endpoint can be used to understand the following before creating settlements.

  • Which destination members they can send settlements to
  • Maximum settlement amounts allowed for each corridor
  • Current settlement activity and capacity constraints:
Query
destinationMemberIdstring^[A-Z0-9_]*$

Optional filter to get context for a specific destination member only.

  • If provided: Returns context for only that specific corridor
  • If omitted: Returns context for all available corridors
Example: destinationMemberId=DEST_MEMBER_1
curl -i -X GET \
  'https://docs.almondfintech.com/_mock/apis/settlements/v2/settlement-context?destinationMemberId=DEST_MEMBER_1'

Responses

Settlement context response

Bodyapplication/json
sourceMemberIdstring

Source member Identifier.

currencystring^[A-Z]{3}$

Source currency supported by the source member for outbound settlements.

corridorsArray of objects(CorridorSettlementContext)

List of available corridors from the source member to various destinations.

Response
application/json
{ "sourceMemberId": "SOURCE_MEMBER", "currency": "USD", "corridors": [ {}, {} ] }
Operations