# Payout

## Get Payout Limits

 - [GET /v2/payout-limits](https://almondfintechapi.redocly.app/apis/payouts/payout/getpayoutlimits.md): Retrieves the minimum and maximum payout limits for payout providers based on the specified country code and/or payout provider ID.

Query Parameters:
- At least one of countryCode or payoutProviderId must be provided.

Response:
- Returns a list of payout limits, each containing the currency code, minimum limit, and maximum limit.

Use Cases:
- Check payout limits before initiating a payout
- Display available payout limits to end users
- Validate payout amounts against configured limits

## Initiate Payout

 - [POST /v2/payouts](https://almondfintechapi.redocly.app/apis/payouts/payout/initiatepayout.md): Creates a new payout with the provided request details.  

- On success, the response includes:  
  * payoutId – Unique identifier for the initiated payout. This ID must be used for subsequent operations (e.g., status checks, cancellation).  
  * payoutStatus – Will return "ACCP" if the payout request is received successfully.  

This endpoint is the entry point for executing a payment or transfer, and serves as the foundation for all subsequent payout lifecycle operations.

## Get Payouts

 - [GET /v2/payouts](https://almondfintechapi.redocly.app/apis/payouts/payout/getpayouts.md): Get payouts with filter and pagination support.

Example Request:

GET /v2/payouts?page=0&size=10&payoutStatus=ACCP&senderCountry=US&beneficiaryCountry=PH


Query Parameters:
- page - Page number (default: 0)
- size - Number of records per page (default: 10)
- sortField - Field to sort by
- sortDirection - Sort direction (ASC/DESC)
- sourceMemberPayoutId - Filter by source member payout ID (your unique payout identifier)
- payoutId - Filter by system payout ID (UUID format)
- creationTime - Filter by creation date (YYYY-MM-DD)
- completionTime - Filter by completion date (YYYY-MM-DD)
- senderName - Filter by sender name
- senderCountry - Filter by sender country code
- beneficiaryName - Filter by beneficiary name
- beneficiaryCountry - Filter by beneficiary country code
- payoutProviderId - Filter by payout provider id
- payoutStatus - Filter by payout status (ACCP, PNDG, PRCD, etc.)

## Process Payout

 - [POST /v2/payouts/{payout-id}/process](https://almondfintechapi.redocly.app/apis/payouts/payout/processpayout.md)

## Get Payout Details

 - [GET /v2/payouts/{payout-id}](https://almondfintechapi.redocly.app/apis/payouts/payout/getpayout.md): Fetches detailed information about a specific payout using its unique payoutId.

Returns comprehensive payout information including:
- Payout details (amount, transfer fee)
- Sender and beneficiary information
- Current payout status
- Timestamps (creation, completion)
- Compliance information

## Get Payout Status

 - [GET /v2/payouts/{payout-id}/status](https://almondfintechapi.redocly.app/apis/payouts/payout/getpayoutstatus.md): Retrieves the current status of a specific payout using its unique payoutId.

Payout Status Values:
- RCVD - Received: Payout request has been received
- ACCP - Accepted: Payout has been accepted for processing
- PNDG - Pending: Payout is pending processing
- PRCD - Processed: Payout has been successfully processed
- RJCT - Rejected: Payout was rejected
- CNCL - Cancelled: Payout was cancelled
- EXPD - Expired: Payout has expired
- FAIL - Failed: Payout processing failed
- RVSD - Reversed: Payout was reversed

Cancellation Status Values (when applicable):
- ACCP - Cancellation accepted
- PNDG - Cancellation pending
- PRCD - Cancellation processed
- RJCT - Cancellation rejected

## Cancel Payout

 - [POST /v2/payouts/{payout-id}/cancel](https://almondfintechapi.redocly.app/apis/payouts/payout/cancelpayout.md): Submits a cancellation request for a specific payout identified by its unique payoutId.