/v1/event/payout/{eventId}

Get a single payout event by its event ID

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieves the full details of a single fiat payout transaction identified by its event ID.

Overview

  • Status Polling: Check whether a payout has moved from pending to completed or failed
  • Recovery: Retrieve payout details (like payout_id, beneficiary, or failure_reason) if the original response to /v1/event execution request was lost or timed out.
  • Reconciliation: Verify amounts, reference, and commission for a specific past payout event.

Request

GET /v1/event/payout/{eventId}

ParameterTypeLocationRequiredDescription
AuthorizationstringHeaderYesYour API key.
eventIduuidPathYesThe unique event ID you generated and sent in the /v1/event execution request.

Response

200 OK

The response returns a PayoutEventResponse object. Note there are two distinct status fields:

FieldTypeDescription
statusstringAPI request status (e.g., "success").
resultobjectThe payout data wrapper.
result.event_idstringThe event ID used for the lookup.
result.statusstringEvent status — the state of the overall execution event.
result.payoutobject or nullThe fiat payout details. May be null if the payout hasn't been created yet for this event.
result.payout.payout_idstringPaybis internal payout identifier.
result.payout.statusstringPayout status — the current state of the fiat payout itself (e.g., pending, completed, failed).
result.payout.amountstringThe payout amount.
result.payout.currencystringThe payout currency.
result.payout.created_atstring (date-time)Timestamp the payout was created.
result.payout.updated_atstring (date-time)Timestamp the payout was last updated.
result.payout.referencestringPayment reference sent to the beneficiary's bank.
result.payout.beneficiaryobjectBusiness or individual beneficiary details.
result.payout.transaction_idstring or nullRelated transaction identifier, if applicable.
result.payout.failure_reasonstring or nullReason for failure, if the payout failed.
result.payout.commissionobjectCommission amount and currency charged for the payout.

Response example

{
  "status": "success",
  "result": {
    "event_id": "e24b0081-8a83-4705-8cd5-7293f2c1c302",
    "status": "completed",
    "payout": {
      "payout_id": "e3c35de7-8e3d-45a5-a753-285ac1c72bfc",
      "amount": "500.00",
      "currency": "EUR",
      "created_at": "2026-08-20T10:15:00Z",
      "updated_at": "2026-08-20T10:17:32Z",
      "reference": "INV-2026-0456",
      "status": "completed",
      "beneficiary": {
        "type": "individual",
        "first_name": "Jane",
        "last_name": "Doe",
        "iban": "DE89370400440532013000"
      },
      "transaction_id": "a734dc96-065f-428d-8562-c6f106f8c9e1",
      "failure_reason": null,
      "commission": {
        "amount": "2.50",
        "currency": "EUR"
      }
    }
  }
}
Path Params
string
required
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json