Jump to Content

Confirm Transaction for Payout Queue

Overview

When a transaction is created with move_to_payout: false, the funds are held in the escrow account and are not automatically released. To schedule a payout for such a transaction, use this endpoint to confirm it and add it to the payout queue for later processing.

Endpoint

https://app-api.edfapay.com/api/v1/payout/trasnaction/{transaction_id}/confirm

Request

Headers

Header	Value
`accept`	`/`
`Authorization`	`Bearer <your_api_key>`

Path Parameters

Parameter	Type	Required	Description
`transaction_id`	`string (UUID)`	✅ Yes	The ID of the escrow transaction to confirm for payout. Must have been created with `move_to_payout: false`.

Body

No request body required.

Response

Success — `200 OK`

{
  "status": "queued",
  "transaction_id": "d90200e2-1811-4094-a3a4-a85e30fb0898",
  "queued_at": "2024-11-15T10:32:00Z"
}

Field	Type	Description
`status`	`string`	Always `"queued"` on success.
`transaction_id`	`string`	The transaction ID that was confirmed and queued.
`queued_at`	`string`	ISO 8601 timestamp of when the transaction was added to the queue.

Error Responses

Status Code	Error	Description
`404 Not Found`	`transaction_not_found`	No transaction found with the provided ID.
`409 Conflict`	`already_queued`	This transaction is already in the payout queue.
`422 Unprocessable Entity`	`invalid_transaction_state`	The transaction is not eligible for queuing (e.g., was not created with `move_to_payout: false`, already paid out, or cancelled).

Error Response Body

{
  "error": "transaction_not_found",
  "message": "No transaction found with ID d90200e2-1811-4094-a3a4-a85e30fb0898."
}

Example

Request

curl -X 'PUT' \
  'https://app-api.edfapay.com/api/v1/payout/transaction/{transaction_id}/confirm' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer <your_api_key>'

Response

{
  "status": "queued",
  "transaction_id": "d90200e2-1811-4094-a3a4-a85e30fb0898",
  "queued_at": "2024-11-15T10:32:00Z"
}

Notes

A transaction can only be confirmed once. Attempting to confirm the same transaction again returns a 409 Conflict.

Queued transactions are processed in the order they were added (FIFO).

Only transactions created with move_to_payout: false are eligible to be confirmed via this endpoint.

To check the current payout queue or the status of a queued transaction, refer to the Payout Queue section.

Updated about 1 month ago