Skip to content

Almond Payout API (1.1.0)

The Almond Payout API enables clients to execute domestic payouts by leveraging local banking partners and payout networks.

As a client, you need to:

  • Authenticate to obtain an access token.
  • Discover payout providers by querying supported providers by country and retrieving provider-specific field requirements.
  • Check payout rates and fees for full transparency on send/receive amounts.
  • Create a payout with the required beneficiary and payment details.

Almond then orchestrates the process — verifying balance availability, executing the payout through the chosen payout partner, and updating the payout status — while providing clients with real-time status updates and notifications.

System Flow
Figure: Payout Flow

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

Request

Retrieves a list of destination members available for the authenticated source member.

Response Details:

  • Returns information about all destination members that have active corridors with the member.
  • Each destination member includes:
    • memberId: Unique identifier for the destination member
    • name: Display name of the destination member/payout partner
    • supportedCcyList: List of currencies supported by this destination member
    • prefundBalance: Current prefund balances for each supported currency

Use Cases:

  • Discover available payout partners for the member
  • Check prefund balances before initiating payouts
  • View supported currencies for each destination member

Business Context:

  • Destination members are payout partners that can receive and disburse funds in their respective countries
  • Prefund balances represent funds already transferred to the destination member for faster payouts
curl -i -X GET \
  https://docs.almondfintech.com/_mock/apis/payouts/v2/destination-members

Responses

Destination members list response

Bodyapplication/json
membersArray of objects(DestinationMemberInfo)
Response
application/json
{ "members": [ {}, {} ] }
Operations
Operations
Operations