Skip to content
API Reference
/
/Static Fields

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
payouts.json
payouts.yaml
Overview
URL
https://www.almondfintech.com/contact-us
Almond Fintech API Support
info@almondfintech.com
License
Copyright © 2025 Almond FinTech. All rights reserved.
Languages
Servers
Mock server
https://docs.almondfintech.com/_mock/apis/payouts
Sandbox
https://api.sandbox.almondfintech.com
Production
https://api.almondfintech.com

Member

Operations

Payout Providers

Operations

Static Fields

Operations

Get Source Of Funds Codes

Request

Returns a list of source of funds codes that can be used when initiating payouts.

These codes indicate where the sender's funds originated from and are used for compliance and regulatory purposes.

curl -i -X GET \
  https://docs.almondfintech.com/_mock/apis/payouts/v2/source-of-funds-codes

Responses

Source of Funds Codes List

Bodyapplication/jsonArray [
codestring

The code value

descriptionstring

Human-readable description of the code

]
Response
application/json
[
  {
    "code": "DONATIONS",
    "description": "Donations"
  },
  {
    "code": "LOTTERY",
    "description": "Lottery"
  },
  {
    "code": "SALARY",
    "description": "Salary"
  },
  {
    "code": "FREELANCE_INCOME",
    "description": "Freelance income"
  },
  {
    "code": "RETIREMENT_FUND",
    "description": "Retirement fund"
  },
  {
    "code": "PROPERTY_SALE",
    "description": "Sale of property"
  },
  {
    "code": "FOREX_GAINS",
    "description": "Forex Gains"
  },
  {
    "code": "PENSION",
    "description": "Pension income/money"
  },
  {
    "code": "FAMILY_INCOME",
    "description": "Family income"
  },
  {
    "code": "FINANCIAL_SUPPORT_FROM_SPOUSE",
    "description": "Financial support from spouse"
  },
  {
    "code": "LOANS",
    "description": "Loan"
  },
  {
    "code": "BUSINESS_INCOME",
    "description": "Income from business"
  },
  {
    "code": "COMMISSION",
    "description": "Commission"
  },
  {
    "code": "PROPERTY_INVESTMENT",
    "description": "Property investment"
  },
  {
    "code": "SHARES_INVESTMENT",
    "description": "Shares investment"
  },
  {
    "code": "SAVINGS",
    "description": "Personal savings"
  },
  {
    "code": "BALANCE_FROM_TRAVELLING",
    "description": "Balance from travelling"
  }
]

Get Purpose Codes

Request

Returns a list of purpose codes that can be used when initiating payouts.

These codes indicate the purpose or reason for the payout and are required for regulatory compliance and reporting.

curl -i -X GET \
  https://docs.almondfintech.com/_mock/apis/payouts/v2/purpose-codes

Responses

Purpose Codes List

Bodyapplication/jsonArray [
codestring

The code value

descriptionstring

Human-readable description of the code

]
Response
application/json
[
  {
    "code": "CONSTRUCTION",
    "description": "Construction costs/expenses"
  },
  {
    "code": "SERVICES_PAYMENT",
    "description": "Services payment"
  },
  {
    "code": "EDUCATION",
    "description": "Education related expenses"
  },
  {
    "code": "MEDICAL",
    "description": "Medical expenses"
  },
  {
    "code": "FAMILY_MAINTENANCE",
    "description": "Family maintenance"
  },
  {
    "code": "PROPERTY_PURCHASE",
    "description": "Purchase of residential property"
  },
  {
    "code": "UTILITIES",
    "description": "Utility bills"
  },
  {
    "code": "PERSONAL_EXPENSES",
    "description": "Personal expenses"
  },
  {
    "code": "INVESTMENT_GAINS",
    "description": "Profits/income from investment"
  },
  {
    "code": "SAVINGS",
    "description": "Personal Savings"
  },
  {
    "code": "SALARY",
    "description": "Salary payment"
  },
  {
    "code": "LEGAL_SERVICES",
    "description": "Legal services"
  },
  {
    "code": "GRANTS",
    "description": "Grants"
  },
  {
    "code": "GIFTS",
    "description": "Gifts"
  },
  {
    "code": "DONATIONS",
    "description": "Donations"
  },
  {
    "code": "WEDDING",
    "description": "Wedding expenses"
  },
  {
    "code": "RELIGIOUS_EXPENSES",
    "description": "Religious expenses"
  },
  {
    "code": "FREELANCE_PAYMENT",
    "description": "freelance payment"
  }
]

Get Relationship Codes

Request

Returns a list of relationship codes that can be used when initiating payouts.

These codes define the relationship between the sender and the beneficiary and are used for compliance verification.

curl -i -X GET \
  https://docs.almondfintech.com/_mock/apis/payouts/v2/relationship-codes

Responses

Relationship Codes List

Bodyapplication/jsonArray [
codestring

The code value

descriptionstring

Human-readable description of the code

]
Response
application/json
[
  {
    "code": "FAMILY",
    "description": "Family"
  },
  {
    "code": "BUSINESS_PARTNER",
    "description": "Business partner"
  },
  {
    "code": "FRIEND",
    "description": "Friend"
  },
  {
    "code": "FRIENDS_FAMILY",
    "description": "Friends family"
  },
  {
    "code": "EMPLOYEE",
    "description": "Employee"
  },
  {
    "code": "SELF",
    "description": "Own Account"
  },
  {
    "code": "SIBLING",
    "description": "Sibling"
  },
  {
    "code": "PARENT",
    "description": "Parent"
  },
  {
    "code": "SPOUSE",
    "description": "Spouse"
  },
  {
    "code": "CHILDREN",
    "description": "Children"
  },
  {
    "code": "SUPPLIER",
    "description": "Supplier"
  },
  {
    "code": "NOT_RELATED",
    "description": "Not related"
  },
  {
    "code": "RELATIVE",
    "description": "Relative"
  },
  {
    "code": "IN_LAWS",
    "description": "In laws"
  },
  {
    "code": "SERVICE_PROVIDER",
    "description": "Service provider"
  },
  {
    "code": "SPOUSE_EMPLOYEE",
    "description": "Spouse employee"
  },
  {
    "code": "SPOUSE_EMPLOYEE_FAMILY",
    "description": "Spouse employees family"
  },
  {
    "code": "CHARITY_RECIPIENT",
    "description": "Receiver of charitable funds"
  }
]

Payout

Operations
Copyright © 2025 Almond FinTech. All rights reserved.