Skip to content
API DocsDocs

Get APM Payout Status

APM Payouts — Get APM Payout Status

2 min readUpdated Mar 27, 2026

GET /api/v1/payouts/apm/status/{id}

Retrieve only the current status of an APM payout transaction.

Guide: Initiating an APM Payout — conceptual walkthrough, flow diagrams, and integration patterns.

#Headers

HeaderValue
AuthorizationBearer {token} — see Authentication

#Request

No request body. The transaction ID is passed as a path parameter.

ParameterTypeDescription
idStringThe unique transaction identifier returned when the transaction was created.

#Response

Returns the transaction status as a plain string.

Possible values: NEW, PENDING, PROCESSING, CUSTOMER_VERIFICATION, SUCCEED, FAILED, CANCELLED, REFUNDED, CHARGEBACK.

See Transaction Status Guide for detailed descriptions of each status.

"SUCCEED"

Polling tip: Use this lightweight endpoint for status checks. For full transaction details, use the corresponding /info/{id} endpoint instead.

#Error Responses

HTTP StatusDescription
400Bad Request — missing or invalid parameters. Check the response body for field-level details.
401Unauthorized — missing, expired, or invalid bearer token. Re-authenticate via POST /api/v1/auth.
404Not Found — the requested resource does not exist.
500Internal Server Error — an unexpected error occurred. Retry with exponential backoff.
curl -X GET https://sandbox.api.exirom.com/api/v1/payouts/apm/status/12345 \
  -H "Authorization: Bearer YOUR_TOKEN"
Was this helpful?