Payments / Payouts

Get payout event

This endpoint populates whenever either a Success URI or Failure URI are called; this information helps track the status and whatever is happening with the committed Payout.

getpayouts/events/:payoutId

Request

Response

OK - If payout hasn't been committed or ID not found

dataobject
codestring
messagestring
displayToUserboolean

Example response

{
  "data": {},
  "code": "352018",
  "message": "No payout event found for supplied id",
  "displayToUser": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.