# Find Transaction by Order reference ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/transactions/by-order-reference/{order_reference}: get: summary: Find Transaction by Order reference deprecated: false description: >- Retrieves details for a specific transaction based on the provided transaction ID. tags: - PlexyPay API/API/Payments/Transaction Management - Transactions parameters: - name: order_reference in: path description: '' required: true schema: type: string responses: '200': description: Successfully retrieved transaction details content: application/json: schema: type: object x-apidog-refs: 01K7EPS3MXTE39HM9QTNMHZ02D: $ref: '#/components/schemas/response.TransactionDetails' x-apidog-overrides: {} properties: actualNettingFractionalUnitPortion: type: integer amount: type: number amountFractionalUnit: type: integer authorizedAt: type: string balanceAfterPayout: type: integer balanceBeforePayout: type: integer chargedAt: type: string createdAt: type: string currency: type: string customerId: type: string description: type: string netAmountFractionalUnit: type: integer netPayoutAmountFractionalUnit: type: integer netSettleAmountFractionalUnit: type: integer paymentId: type: string paymentLinkId: type: string paymentMethod: type: string payoutFeeAmount: type: integer recurringType: type: string secure3d: type: boolean status: type: string storeId: type: string updatedAt: type: string orderMetadata: type: object description: >- Optional merchant-defined metadata associated with the order. Contains up to 5 string key/value pairs. Keys must contain 1–40 characters; values must contain at most 100 characters. Nested objects and non-string values are not allowed. maxProperties: 5 propertyNames: type: string minLength: 1 maxLength: 40 additionalProperties: type: string maxLength: 100 examples: - crmOrderId: CRM-456 source: mobile-app x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] splitRequests: type: array items: $ref: '#/components/schemas/entity.SplitRequest' required: - splitRequests x-apidog-orders: - 01K7EPS3MXTE39HM9QTNMHZ02D - splitRequests x-apidog-ignore-properties: - actualNettingFractionalUnitPortion - amount - amountFractionalUnit - authorizedAt - balanceAfterPayout - balanceBeforePayout - chargedAt - createdAt - currency - customerId - description - netAmountFractionalUnit - netPayoutAmountFractionalUnit - netSettleAmountFractionalUnit - paymentId - paymentLinkId - paymentMethod - payoutFeeAmount - recurringType - secure3d - status - storeId - updatedAt - orderMetadata headers: {} x-apidog-name: OK '400': description: Invalid transaction ID content: application/json: schema: &ref_0 $ref: '#/components/schemas/response.Error' headers: {} x-apidog-name: Bad Request '401': description: Unauthorized content: application/json: schema: *ref_0 headers: {} x-apidog-name: Unauthorized '404': description: Transaction not found content: application/json: schema: *ref_0 headers: {} x-apidog-name: Not Found '500': description: Internal server error content: application/json: schema: *ref_0 headers: {} x-apidog-name: Internal Server Error security: - PrivateKeyAuth: [] x-apidog: schemeGroups: - id: UqjDdFdPEOUpIam-fChgk schemeIds: - PrivateKeyAuth required: true use: id: UqjDdFdPEOUpIam-fChgk scopes: UqjDdFdPEOUpIam-fChgk: PrivateKeyAuth: [] x-client: - merchant_portal - merchant_api x-apidog-folder: PlexyPay API/API/Payments/Transaction Management x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/1075475/apis/api-24694801-run components: schemas: entity.SplitRequest: type: object properties: id: type: string x-apidog-mock: '{{$string.uuid}}' paymentBeneficiaryId: type: string x-apidog-mock: '{{$string.uuid}}' merchantId: type: string x-apidog-mock: '{{$string.uuid}}' transactionId: type: string x-apidog-mock: '{{$string.uuid}}' netAmout: type: integer x-apidog-mock: '{{$string.numeric}}' description: fractional unit x-apidog-orders: - id - paymentBeneficiaryId - merchantId - transactionId - netAmout required: - id - paymentBeneficiaryId - merchantId - transactionId - netAmout x-apidog-ignore-properties: [] x-apidog-folder: '' response.TransactionDetails: properties: actualNettingFractionalUnitPortion: type: integer amount: type: number amountFractionalUnit: type: integer authorizedAt: type: string balanceAfterPayout: type: integer balanceBeforePayout: type: integer chargedAt: type: string createdAt: type: string currency: type: string customerId: type: string description: type: string netAmountFractionalUnit: type: integer netPayoutAmountFractionalUnit: type: integer netSettleAmountFractionalUnit: type: integer paymentId: type: string paymentLinkId: type: string paymentMethod: type: string payoutFeeAmount: type: integer recurringType: type: string secure3d: type: boolean status: type: string storeId: type: string updatedAt: type: string orderMetadata: type: object description: >- Optional merchant-defined metadata associated with the order. Contains up to 5 string key/value pairs. Keys must contain 1–40 characters; values must contain at most 100 characters. Nested objects and non-string values are not allowed. maxProperties: 5 propertyNames: type: string minLength: 1 maxLength: 40 additionalProperties: type: string maxLength: 100 examples: - crmOrderId: CRM-456 source: mobile-app x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] type: object x-apidog-orders: - actualNettingFractionalUnitPortion - amount - amountFractionalUnit - authorizedAt - balanceAfterPayout - balanceBeforePayout - chargedAt - createdAt - currency - customerId - description - netAmountFractionalUnit - netPayoutAmountFractionalUnit - netSettleAmountFractionalUnit - paymentId - paymentLinkId - paymentMethod - payoutFeeAmount - recurringType - secure3d - status - storeId - updatedAt - orderMetadata x-apidog-ignore-properties: [] x-apidog-folder: '' response.Error: description: The structure for error details in API responses properties: code: allOf: - $ref: >- #/components/schemas/git_plexypay_com_ecom_back_api_internal_platform_errors.Code enum: - 1 - 2 - 3 examples: - 1 failureUrl: type: string message: allOf: - $ref: '#/components/schemas/errors.Message' examples: - something went wrong source: allOf: - $ref: '#/components/schemas/errors.Source' enum: - keys - customers - reports - merchants - transactions - paymentLinks examples: - paymentLinks success: type: boolean examples: - true transactionId: type: string type: allOf: - $ref: '#/components/schemas/errors.Type' enum: - apiError - ' validationError' examples: - apiError type: object x-apidog-orders: - code - failureUrl - message - source - success - transactionId - type x-apidog-ignore-properties: [] x-apidog-folder: '' errors.Type: enum: - apiError - validationError - authorizationError - bankAcquirerError - internalError type: string x-enum-varnames: - APIErrorType - ValidationErrorType - AuthorizationErrorType - BankAcquirerErrorType - InternalErrorType x-apidog-folder: '' errors.Source: enum: - keys - customers - reports - merchants - transactions - paymentLinks - sessions - payments - settlements - auth - dossier - documents - onboarding - result-codes - cards - applePay - token-management - decryption - auth-service - fiscalization - walletOperations type: string x-enum-varnames: - KeysServiceSource - CustomersServiceSource - ReporsServiceSource - MerchantsServiceSource - TransactionsServiceSource - PaymentLinksSource - SessionsSource - PaymentsSource - SettlementsSource - AuthSource - DossierSource - DocumentsSource - OnboardingSource - ResultCodeSource - CardsSource - ApplePaySource - TokenManagementSource - DecryptionSource - AuthServiceSource - FiscalizationSource - WalletOperationsSource x-apidog-folder: '' errors.Message: enum: - service unavailable - something went wrong - invalid merchant ID - invalid store ID - invalid customer ID - invalid request - entity not found - missing or malformed token - missing or malformed key - invalid session ID - invalid user ID - permission denied - currency is not supported type: string x-enum-varnames: - ServiceUnavailableMessage - SomethingWentWrongMessage - InvalidMerchantIDMessage - InvalidStoreIDMessage - InvalidCustomerIDMessage - InvalidRequestMessage - EntityNotFoundMessage - MissingOrMalformedToken - MissingORMalformedKey - InvalidSessionIDMessage - InvalidUserIDMessage - PermissionDeniedMessage - CurrencyIsNotSupported x-apidog-folder: '' git_plexypay_com_ecom_back_api_internal_platform_errors.Code: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 1008 - 1009 - 1010 type: integer x-enum-varnames: - ServiceUnavailableCode - SomethingWentWrongCode - InvalidRequestParamsCode - NotFoundCode - UnprocessableEntityCode - MissingOrMalformedTokenCode - MissingOrMalformedKeyCode - InvalidSessionIDCode - PermissionDeniedCode - ConflictCode x-apidog-folder: '' securitySchemes: BearerAuth: description: >- Type "Bearer" followed by a space and JWT token or Private API key for merchant authentication in: header name: Authorization type: apikey PrivateKeyAuth: description: Private API key for merchant authentication. in: header name: Authorization type: apikey ApiKeyAuth: type: apikey in: header name: x-api-key description: >- Use a test API key for simulated transactions and a live APSE API key for production. ApiKeyAuth1: type: apikey in: header name: Authorization description: Pass **raw API key**. Do **NOT** prefix with Bearer. servers: - url: https://api.plexypay.com description: Production API security: [] ```