Process Awaiting Funds

Process Awaiting Funds

POST {{Environment_URL}}/v1/payments/payouts/process-awaiting-funds/

This endpoint is designed to initiate payout operations that are currently in an AWAITING_FUNDS status.

• Include the desired payout ID(s) in the request body payload to begin processing.

• While the endpoint supports processing multiple payouts per request, you can choose to include only a single payout ID if preferred.

• Before executing this endpoint, ensure that your account balance is sufficient to cover all the payouts. If your balance is insufficient, the endpoint will process payouts only until the account reaches the minimum balance required for generating payouts.

• On a successful response, the API will return two arrays:

  • queuedPayoutIds – contains the IDs of the payouts that have been successfully queued for processing.

  • excludedPayoutIds – contains the IDs of the payouts that were not processed, typically due to insufficient funds. These payouts will remain in the AWAITING_FUNDS status.

Headers

Name	Value
Authorization	Bearer <token>

Body

Name	Type	Description	Value
payoutId	array	Payouts to process	["2f0075b5-d99b-4914-a34d-540e1d4b0d68", "2fb44424-fc78-4578-ba4e-ee0b255f603b", "d8c2f7eb-7548-4f13-8679-f1ff67022482"]

Request Body

Process Awaiting Funds

{
  "payoutId": [
    "2f0075b5-d99b-4914-a34d-540e1d4b0d68",
    "2fb44424-fc78-4578-ba4e-ee0b255f603b",
    "d8c2f7eb-7548-4f13-8679-f1ff67022482"
  ]
}

Response

201 - CREATED

{
  "message": "Payout processing requests handled",
  "queuedPayoutIds": [
		"69f61317-7582-4fa7-9410-17f5db5561f2"
	],
  "excludedPayoutIds": [
    "619bf859-b742-4c96-bdd5-1f924965cb4c",
    "5dd910d1-e21d-4979-bb86-a552607a02c1"
  ]
}