Skip to main content
GET
Get a payout

Purpose

Get the status of a payout and its batches.

When to use

Poll every 2–5 seconds after Create a payout, Retry or Mark as paid, until status is completed or failed. The payout has payoutMethod (for example other) and comment. batches[].markAsPaid has marked only. Part of the Pay vendors with the API flow.

Request and response

The parameters, request body, code examples (curl and other languages) and a full response example are shown below this section. They are generated from the OpenAPI spec.

Errors

Every error has the shape {"success": false, "error": {"code", "message", "errorId", "details"}}. Branch on error.code.

Previous step

Create a payout

Next step

List payout transactions

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Path Parameters

transactionId
string
required

The transactionId returned by the 202 ack of make-payment, retry or mark-paid

Pattern: ^[A-Za-z0-9_-]{1,64}$

Response

The latest run's status and the transaction's batches

success
boolean
data
object