Skip to content
API Reference
/
Payouts
/
/
Get Payout Providers

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

Get Payout Providers

Request

Returns a list of supported payout providers.

If countryCode is provided, only payout providers for the specified country are returned. Without countryCode, all supported payout providers are returned.

Query
countryCodestring^[A-Za-z]{2}$

ISO alpha-2 Country Code of payout provider

Example: countryCode=ID
payoutMethodstring(PayoutMethodEnum)

Payout Method

Default "BANK_ACCOUNT"
Enum"BANK_ACCOUNT""CASH_PICKUP""WALLET"
segmentstring(SegmentEnum)

C2C: From an individual to an individual,

B2B: From a business to a business

Default "C2C"
Enum"C2C""B2B"
curl -i -X GET \
  'https://docs.almondfintech.com/_mock/apis/payouts/v2/payout-providers?countryCode=ID&payoutMethod=BANK_ACCOUNT&segment=C2C'

Responses

Payout Providers list response

Bodyapplication/json
payoutProvidersArray of objects(PayoutProviderInfo)
Default []
Response
application/json
{
  "payoutProviders": [
    { … }
  ]
}

Get Payout Provider

Request

This API provides a comprehensive list of fields, including their respective data types and validation specifications, necessary for initiating a payout API request.

Path
payout-provider-idstring^[A-Za-z0-9-]*$required

Payout provider Id

Example: BABC
Query
payoutMethodstring(PayoutMethodEnum)

BANK_ACCOUNT: Bank Account service,

CASH_PICKUP: Cash pickup service,

WALLET: Wallet service

Default "BANK_ACCOUNT"
Enum"BANK_ACCOUNT""CASH_PICKUP""WALLET"
segmentstring(SegmentEnum)

C2C: From an individual to an individual,

B2B: From a business to a business

Default "C2C"
Enum"C2C""B2B"
curl -i -X GET \
  'https://docs.almondfintech.com/_mock/apis/payouts/v2/payout-providers/BABC?payoutMethod=BANK_ACCOUNT&segment=C2C'

Responses

Payout provider response

Bodyapplication/json
namestring
payoutProviderIdstring
countryCodestring
payoutMethodstring
supportedSegmentsArray of strings(SegmentEnum)
Items Enum"C2C""B2B"
cashPickupLocationobject(CashPickupAddress)
payoutInitiateRequestFieldsArray of objects(Field)
Response
application/json
{
  "name": "Bank ABC Indonesia",
  "payoutProviderId": "BABC",
  "countryCode": "ID",
  "payoutMethod": "BANK_ACCOUNT",
  "supportedSegments": [
    "C2C",
    "B2B"
  ],
  "payoutInitiateRequestFields": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Static Fields

Operations

Payout

Operations
Copyright © 2025 Almond FinTech. All rights reserved.