Sign in

Get a request

Inspect a customer-owned Request. Poll queued or running requests after retryAfterSeconds. Successful output is retained for 24 hours; metadata remains after the result expires.

get/v1/requests/{id}

Path parameters

idstring uuid required

Response

Current request snapshot.

completedAtstring date-time
createdAtstring date-time required
expiresAtstring date-time
requestIdstring uuid required
resultExpiredboolean
retryAfterSecondsinteger
serviceOutcome'served' | 'valid_negative' | 'caller_error' | 'service_failure' | 'rejected'

End-to-end AnyAPI service result when known; independent of payment settlement.

settlementState'not_required' | 'pending' | 'settled' | 'reconcile' | 'charged_undelivered' | 'writeoff'

Payment settlement state when known; independent of request lifecycle status.

skustring required
status'queued' | 'running' | 'succeeded' | 'failed' | 'expired' required

Changes

Changed in 5 of the 450 revisions of this API.9

  • 156bc98d28021See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 1f6d99b8eadf2See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 10b9a3cf14dc2See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 162b6891cbfa3See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      the response property / became required for the status

      response-property-became-required

  • f9c8f64347941See the full diff
    • ○

      endpoint added

      endpoint-added

Of the 450 revisions, 2 have no diff computed.