Read a payout

GET

payouts

{payoutId}

curl --request GET \
  --url https://extensions-sandbox.lumx.io/payments/payouts/{payoutId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "pa_000000000000",
  "status": "processing"
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

payoutId

string

required

200 - application/json

string

required

The ID of the payout.

status

enum<string>

required

The current status of the payout.

Available options:

processing,

failed,

refunded,

completed

curl --request GET \
  --url https://extensions-sandbox.lumx.io/payments/payouts/{payoutId} \
  --header 'Authorization: Bearer <token>'

{
  "id": "pa_000000000000",
  "status": "processing"
}