Retrieve a payment

GET /payments/:id

Returns a single payment object by ID.

Request

Responses

The requested payment.

Missing or invalid API key.

Cause: One of three things; see error in the response body:

no_api_key: the Authorization header was omitted entirely.
invalid_api_key: a header was sent but the token isn't a recognized PayFlow key (wrong scheme, malformed, or a test-mode key used against production, or vice versa).
api_key_expired: the key was valid but has since been rotated or revoked.

Fix: Send Authorization: Bearer <your API key>. For api_key_expired, generate a new key in the Dashboard and update the integration.

Retry: Safe, but will keep failing until a valid, current key for the right environment is supplied.

Payment not found.

Cause: No payment exists with the given id (error: resource_not_found), either because it was mistyped or it belongs to a different account/environment (for example, a test-mode ID used against production). In the sandbox, only IDs returned by a prior createPayment/retrievePayment call resolve.

Fix: Double-check the id and that you're using the correct API key/environment.

Retry: Safe, but will keep failing until the id or environment is corrected.

Rate limit exceeded.

Cause: Too many requests were sent from this API key within the current window.

Fix: Slow down request rate and honor the Retry-After header if present. Consider batching or caching reads where possible.

Retry: Safe after waiting out the window; retrying immediately will fail again.

Response Headers

X-RateLimit-Limit

The maximum number of requests allowed per window.

X-RateLimit-Remaining

Requests remaining in the current window.

X-RateLimit-Reset

Unix timestamp (seconds) when the current window resets.

Retry-After

Seconds to wait before retrying.

Retrieve a payment

/payments/:id

Request​

Responses​

Request

Responses