> ## Documentation Index > Fetch the complete documentation index at: https://docs.payrails.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code. > Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it. > Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code. > Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation. > Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent. > Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format. > Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code. # Get Payment Operations by Payment ID > Find a payment operation from a given `paymentID`. ## OpenAPI ````yaml https://cdn.payrails.io/docs/api/openapi.min.json get /payment/payments/{paymentId}/operations openapi: 3.1.0 info: version: 1.3.15 title: Payrails API Reference contact: name: Payrails url: https://www.payrails.com email: tech@payrails.com license: name: Payrails GmbH url: https://www.payrails.com/ description: > --- Payrails provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. servers: - url: https://api.staging.payrails.io description: Payrails environment. security: - ApiKey: [] tags: - name: 3D Secure description: Operations to monitor 3DS operations. - name: Actions description: >- A workflow execution action is a predefined interaction that can be triggered to change the state of the workflow execution. For example authorizing or refunding a payment. - name: API Logs description: API Logs. - name: Authentication description: >- Payrails API is secured via [OAuth 2.0](https://datatracker.ietf.org/doc/html/rfc6749) industry-standard protocol for authorization. Server-side requests are authenticated using a [Bearer Token](https://datatracker.ietf.org/doc/html/rfc6750) in the request `Authorization` header. - name: BIN Lookup description: >- Operations related to getting information about a card by its BIN (or IIN). - name: Client description: Endpoints used by our client-side SDK. - name: Disputes description: Operations to managing disputes. - name: Drop-in Links description: >- Create and manage drop-in payment links that can be shared with payers. Drop-in links support full or partial payments, define the total amount and expiration, and return a public URL that merchants can send to customers. - name: Executions description: >- A workflow execution is an act of performing a set of tasks that are defined in the [Workflow](/api-reference/reference/#operation/listDefaultWorkflows) such as accepting payments. - name: Files description: Operations related to files processing - name: Fraud Checks description: >- A Fraud check Payrails is a collection of operations over time, that is created by a workflow execution and followed by the workflow actions. In this section, you can list all the fraud entities or a single one to learn about the details of involved instruments, providers, statuses, decisions and more. - name: Holders description: >- A Holder is a group of accounts that belong together with specific criteria, linked to their payment instruments and identities. For example, it can represent a digital wallet for a person, where they store balance that they top up, refunded orders, referral bonuses, etc. - name: Instrument Tokens description: >- Tokens are representations of our payment instruments in external providers. One payment instrument can have many tokens, because we keep the mapping in each external provider that knows about it. For example, the same real life card can have a token in our Vault, but also in Adyen and Checkout PSPs. - name: Instruments description: >- Payment instruments are specific instances of a payment method that belong to the holder executing the workflow. They can be a previously stored card, a new card that was typed in a form, a phone number, an IBAN, or some way to fetch an account in a provider (like PayPal or AliPay). - name: Payments description: >- A [Payment](/guides/whats-payrails/payments/) in Payrails is a collection of operations over time, that is created by a workflow execution and followed by the workflow actions. In this section, you can list all the payments or a single one to learn about the details of involved payment methods, instruments, providers, statuses and more. - name: Payouts description: Payouts are money movements paid to an external party. - name: Provider Configs description: Operations related to managing configurations for Providers. - name: Providers description: Operations related to managing Providers. - name: Reconciliation Records description: >- Operations to retrieve reconciliation record aggregates, transactions, and reconciliation metadata. - name: Report Runs description: Operations to generate and retrieve report runs. - name: Reports description: Operations to see available reports. - name: Rulesets description: Operations related to managing Rulesets. - name: SSO Connections description: Operations related to managing SSO identity provider connections. - name: Vault Display SDK description: Operations related to DisplaySDK. - name: Vault Instant Proxy description: Operations related to Instant Proxy API requests. - name: Vault Proxy Connections description: Operations related to managing token connections. - name: Vault Public Encryption description: Public endpoints related to encryption. - name: Vault Records and Aliases description: Operations related to managing records and aliases. - name: Workflows description: >- Any operation in Payrails is defined and executed with a [Workflow](/guides/whats-payrails/workflow/) that is configured for a particular use-case of the merchant. The workflow configurations support versioning. - name: Workspaces description: Operations related to managing workspaces. paths: /payment/payments/{paymentId}/operations: get: tags: - Payments summary: Get Payment Operations by Payment ID description: Find a payment operation from a given `paymentID`. operationId: getPaymentOperations parameters: - name: paymentId in: path description: Identifier of the resource in Payrails. required: true schema: type: string format: uuid example: d5454c2f-ae5e-44f3-8edf-f6dad64f005f - name: includeLatency in: query schema: type: boolean description: Include latency in the response. - name: includeLogs in: query schema: type: boolean description: Include operation logs in the response. responses: '200': description: Success. content: application/json: schema: type: object properties: results: type: array items: type: object required: - id - result properties: id: type: string format: uuid description: >- Unique identifier of the Payment Operation in Payrails. createdAt: type: string format: date-time description: >- Exact date and time when the Payment Operation was created in Payrails. Possibly differs slightly from the date in the PSP. updatedAt: type: string format: date-time description: >- Exact date and time when the Payment Operation was updated in Payrails. Possibly differs slightly from the date in the PSP. paymentId: type: string format: uuid description: >- Unique identifier of the Payment that this Operation belongs to in Payrails. type: type: string description: Operation Type that was executed in the Provider. enum: - Authorize - Preauthorize - Capture - Cancel - Refund - Credit - SendNotification - CaptureNotification - RefundNotification - CancelNotification - AuthorizeNotification - ChargebackNotification - ChargebackReverseNotification - Get - Search - GetToken - Tokenize - DisableToken - Register - Generate3DS - Validate3DS - PayerAuthInit - PayerAuthCheckEnroll - PayerAuthValidate - RefundFailedNotification - RefundReversedNotification - CaptureFailedNotification - ValidateRedirect - RefundNotificationUpdated reason: type: string description: Reason why the operation was done. providerReference: type: string description: >- Unique identifier of the Payment Operation in an external system. Some PSPs provide a specific ID for each update in the Payment, but most of them use the same as the original Payment. paymentStatus: type: string description: The payment status just after the operation done. amount: type: object required: - value - currency properties: value: type: string pattern: '[0-9]+(\.[0-9]+)?' example: '12.50' description: >- Decimal amount of the major currency unit. Can be any precision. currency: type: string pattern: ^[A-Z]{3}$ example: EUR description: ISO 3-letter currency code. result: type: string description: >- Result of the Operation according to Payrails mapping from the provider response. enum: - Success - Accepted - Pending - HTTPRedirectRequired - FormRedirectRequired - Unknown - UnexpectedProviderResponse - ProviderUnknownError - ProviderConnectionError - Timeout - ProviderTimeout - GenericRejection - FraudRisk - DuplicateOperation - OperationNotAllowed - InstrumentNotAllowed - InvalidInstrument - InsufficientBalance - BlockedInstrument - ExpiredInstrument - ValidationError - ParamsError - ProviderConfigError - InvalidSignature - InternalServerError - PayerCanceled - AuthenticationError - AuthenticationRequired - LimitExceeded - PaymentMethodNotSupported - AuthorizationRevoked responseCode: type: string description: >- Original response code from the PSP, which Payrails interpreted for the result field. requiredActionDetails: type: object description: >- In case a Provider requests an action to continue executing an Operation, this object contains the necessary information for it. properties: redirectUrl: type: string description: >- The URL that the Merchant should redirect the user to. redirectMethod: type: string description: >- The HTTP method that should be used when redirecting to the `redirectUrl`. enum: - GET - POST parameters: type: object description: >- Map of parameters that are necessary for the redirection. In case the `redirectMethod` is `GET`, these parameters can be appended in the query string, but if it's `POST`, they should be sent via form. additionalProperties: type: string errorDetails: type: string description: Error details from the provider. acquirerReference: type: string description: >- Acquirer Reference Number (ARN) for the Payment Operation (only Refunds and Captures), which we receive from some of the Provider. workspaceId: type: string format: uuid description: >- Workspace ID that the workflow configuration belongs to. operationLogs: type: array items: type: object description: >- Whenever there is an interaction with an external provider, Payrails records a Log to keep the exact information about what was sent and received. properties: id: type: string format: uuid description: >- Unique identifier of the Payment Operation Log in Payrails. createdAt: type: string format: date-time description: >- Exact date and time when the Payment Operation Log was created in Payrails. Possibly differs slightly from the date in the PSP. operationId: type: string format: uuid description: >- Unique identifier of the Payment Operation that this Log belongs to in Payrails. input: type: string description: Original request object sent to the Provider. output: type: string description: >- Original response object received from the Provider. workspaceId: type: string format: uuid description: >- Workspace ID that the workflow configuration belongs to. description: >- List of operation logs associated with this operation. providerLatency: type: string description: Latency of the operation on the provider side. totalLatency: type: string description: Total latency of the operation. example: results: - id: fe44e4b6-8d32-4ce7-8a80-64332ba49809 createdAt: '2021-01-05T10:20:00.000Z' updatedAt: '2021-01-05T10:20:00.000Z' paymentId: 1bac22d8-5d64-4aa9-b6a6-cbbbda3c3a35 type: Authorize providerReference: reference amount: value: '10.0' currency: GBP result: Accepted responseCode: '200' reason: '' acquirerReference: arn1702287523792 workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a providerLatency: 807.529ms totalLatency: 920.229ms - id: 88604bba-7414-4707-abfe-260ed60ea80e createdAt: '2021-01-05T10:20:00.000Z' updatedAt: '2021-01-05T10:20:00.000Z' paymentId: 1bac22d8-5d64-4aa9-b6a6-cbbbda3c3a35 type: Authorize providerReference: reference amount: value: '10.0' currency: GBP result: Success responseCode: '201' reason: '' acquirerReference: arn1702287523792 workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a providerLatency: 1.10529s totalLatency: 1.203448s - id: b53bbb70-55d0-11ed-bdc3-0242ac120002 createdAt: '2021-01-05T10:20:00.000Z' updatedAt: '2021-01-05T10:20:00.000Z' paymentId: 76cd18a2-10ef-40db-8506-ee0db5d98633 type: Refund providerReference: ref1 amount: value: '10.0' currency: GBP result: Success responseCode: '201' reason: DamagedProduct acquirerReference: arn1702287523792 workspaceId: 7f9f1882-a103-408d-ac96-46a7021e537a providerLatency: 201.076ms totalLatency: 234.4291ms '400': description: Bad Request. content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object description: >- Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure). required: - id - code - detail properties: id: type: string format: uuid description: >- Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster. code: type: string description: >- Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. reason: type: object additionalProperties: true description: >- Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`. example: errors: - id: a24bc325-3929-4d9d-9c08-b3aa532685b7 code: request.malformed detail: The request has malformed syntax docUrl: >- https://docs.payrails.com/docs/resources/error-codes#requestmalformed '401': description: Unauthorized. content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object description: >- Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure). required: - id - code - detail properties: id: type: string format: uuid description: >- Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster. code: type: string description: >- Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. reason: type: object additionalProperties: true description: >- Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`. example: errors: - id: a24bc325-3929-4d9d-9c08-b3aa532685b7 code: request.unauthorized detail: >- The request lacks necessary credentials to perform the specified action docUrl: >- https://docs.payrails.com/docs/resources/error-codes#requestunauthorized '403': description: Insufficient Scope. content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object description: >- Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure). required: - id - code - detail properties: id: type: string format: uuid description: >- Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster. code: type: string description: >- Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. reason: type: object additionalProperties: true description: >- Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`. example: errors: - id: e7db22b3-914e-4975-928e-9edfb0885bea code: request.forbidden detail: >- The request credentials lack the required permissions to perform the specified action docUrl: >- https://docs.payrails.com/docs/resources/error-codes#requestforbidden '404': description: Not Found. content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object description: >- Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure). required: - id - code - detail properties: id: type: string format: uuid description: >- Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster. code: type: string description: >- Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. reason: type: object additionalProperties: true description: >- Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`. example: errors: - id: a24bc325-3929-4d9d-9c08-b3aa532685b7 code: request.not-found detail: The requested resource was not found docUrl: >- https://docs.payrails.com/docs/resources/error-codes#requestnot-found '429': description: Too Many Requests. content: application/json: schema: type: object required: - errors properties: errors: type: array items: type: object description: >- Error struct that includes the error, cause, reason, and possible resolutions. Check the full documentation [here](https://docs.payrails.com/docs/resources/error-codes#error-structure). required: - id - code - detail properties: id: type: string format: uuid description: >- Unique identifier of the error. Please use this value when reporting an issue to our team, so we can help you faster. code: type: string description: >- Machine-friendly error code assigned to the error. Check the full list of possible values [here](https://docs.payrails.com/docs/resources/error-codes#list-of-error-codes). detail: type: string description: >- Human-readable description about the error, its cause, and resolution. docUrl: type: string description: >- Link to the specific documentation about this particular `code`. reason: type: object additionalProperties: true description: >- Metadata providing more details about the reason of the error. The structure of this object varies according to the `code`. example: errors: - id: a24bc325-3929-4d9d-9c08-b3aa532685b7 code: request.rate-limit detail: Too many requests docUrl: >- https://docs.payrails.com/docs/resources/error-codes#requestrate-limit security: - BearerToken: - payments:read components: securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: > You can use your secret API key in the `x-api-key` header of your API requests for supported endpoints: `x-api-key: `. API keys are environment specific and should be securely guarded. You don't have your API key yet? Contact your Payrails account manager. BearerToken: type: http scheme: bearer bearerFormat: JWT description: > You can use an OAuth2 JWT bearer token in the `Authorization` header of your API requests for supported endpoints: `Authorization: Bearer `. These tokens are valid for 10 minutes and can be requested via the [access token endpoint](#operation/getOAuthToken) endpoint. ```` ## Related topics - [Get Payment Operation Logs by Payment Operation ID](/reference/getpaymentoperationlogs.md) - [Get Fraud Operation Logs by Fraud Operation ID](/reference/getfraudoperationlogs.md) - [Get Fraud Operations by Fraud ID](/reference/getfraudoperations.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.