> ## Documentation Index > Fetch the complete documentation index at: https://docs.flipeet.io/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a checkout > Looks up one of your checkouts by the `txRef` returned when you created it. Use it to confirm a payment if you missed its webhook. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/transaction openapi: 3.0.0 info: title: Flipeet Pay API version: '1.0' description: >- Accept and send stablecoin and local-currency payments. Authenticate with your secret key in the x-api-key header. Keys starting fpay_test_ use the sandbox; fpay_live_ moves real money. Guides: https://docs.flipeet.io contact: name: Flipeet Pay url: https://docs.flipeet.io servers: - url: https://api.pay.flipeet.io security: - x-api-key: [] tags: - name: Checkout description: >- Hosted payment pages: create a payment, send your customer to checkoutUrl, and get a webhook when they pay. - name: Deposits description: >- Collect stablecoins or local currency straight into your balance, with your own UI. - name: Balance description: What you hold, per asset. - name: Withdrawals description: Send funds from your balance to a wallet or a bank account. - name: Ramps description: >- Convert between local currency and stablecoins for your own customers, settled to their wallet or bank. - name: Webhooks description: Delivery history, resends and test events. - name: Sandbox description: 'Test-mode tools: simulate outcomes and add test funds. Sandbox keys only.' paths: /api/v1/transaction: get: tags: - Checkout summary: Retrieve a checkout description: >- Looks up one of your checkouts by the `txRef` returned when you created it. Use it to confirm a payment if you missed its webhook. operationId: TransactionController_getTransactionByMerchant parameters: - name: txRef required: true in: query schema: type: string description: The checkout's `txRef`, from **Create a checkout**. responses: '200': description: Transaction retrieved successfully. content: application/json: schema: type: object properties: message: type: string example: Transaction retrieved successfully. status: type: string example: success statusCode: type: number example: 200 data: type: object properties: id: type: string example: 2b7c4e1a-9d3f-4a6b-8c2e-5f1d0a9b8c7d amount: type: number example: 25000 asset: type: string example: usdc checkoutUrl: type: string example: >- https://pay.flipeet.io/checkout?ref=fp_8f2k3m&theme=light currency: type: string example: NGN memo: type: string example: 'Order #1042' merchantName: type: string example: Ada Stores merchantLogo: type: string nullable: true example: null network: type: string example: base payer: type: string example: '0x5aE1c3B0d2F4e6A8b0C2d4E6f8A0b2C4d6E89c21' payableAmount: type: number example: 16.67 payerEmail: type: string example: ada@example.com paymentDate: type: string example: '2026-11-04T10:21:09.000Z' paymentAddress: type: string example: '0x8b3F5a7C9e1B3d5F7a9C1e3B5d7F9a1C3e5B02aD' reference: type: string example: order_1042 feeAmount: type: number example: 125 feePercentage: type: number example: 0.5 txRef: type: string example: fp_8f2k3m txHash: type: string example: >- 0x4f9e2a6c8e0b2d4f6a8c0e2b4d6f8a0c2e4b6d8f0a2c4e6b8d0f2a4c6e8bb7c1 theme: type: string example: light redirectUrl: type: string example: https://shop.example.com/thanks status: type: string example: completed mode: type: string example: live livemode: type: boolean example: true createdAt: type: string example: '2026-11-04T10:21:09.000Z' example: message: Transaction retrieved successfully. status: success statusCode: 200 data: id: 2b7c4e1a-9d3f-4a6b-8c2e-5f1d0a9b8c7d amount: 25000 asset: usdc checkoutUrl: https://pay.flipeet.io/checkout?ref=fp_8f2k3m&theme=light currency: NGN memo: 'Order #1042' merchantName: Ada Stores merchantLogo: null network: base payer: '0x5aE1c3B0d2F4e6A8b0C2d4E6f8A0b2C4d6E89c21' payableAmount: 16.67 payerEmail: ada@example.com paymentDate: '2026-11-04T10:21:09.000Z' paymentAddress: '0x8b3F5a7C9e1B3d5F7a9C1e3B5d7F9a1C3e5B02aD' reference: order_1042 feeAmount: 125 feePercentage: 0.5 txRef: fp_8f2k3m txHash: >- 0x4f9e2a6c8e0b2d4f6a8c0e2b4d6f8a0c2e4b6d8f0a2c4e6b8d0f2a4c6e8bb7c1 theme: light redirectUrl: https://shop.example.com/thanks status: completed mode: live livemode: true createdAt: '2026-11-04T10:21:09.000Z' '400': $ref: '#/components/responses/Error400' '401': $ref: '#/components/responses/Error401' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' security: - x-api-key: [] components: responses: Error400: description: The request is invalid. `details.errors` lists every problem. content: application/json: schema: type: object properties: message: type: string description: What went wrong, for people. May be reworded. status: type: string example: error statusCode: type: integer description: The HTTP status. code: type: string description: A stable code to branch on. enum: - invalid_request - authentication_failed - permission_denied - not_found - conflict - rate_limited - internal_error - provider_error details: type: object nullable: true description: For validation errors, `errors` lists every problem. requestId: type: string description: Quote it when you contact us. timestamp: type: string format: date-time example: message: Amount must be a positive number status: error statusCode: 400 code: invalid_request details: errors: - Amount must be a positive number requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b timestamp: '2026-11-04T10:00:00.000Z' Error401: description: The API key is missing, mistyped or revoked. content: application/json: schema: type: object properties: message: type: string description: What went wrong, for people. May be reworded. status: type: string example: error statusCode: type: integer description: The HTTP status. code: type: string description: A stable code to branch on. enum: - invalid_request - authentication_failed - permission_denied - not_found - conflict - rate_limited - internal_error - provider_error details: type: object nullable: true description: For validation errors, `errors` lists every problem. requestId: type: string description: Quote it when you contact us. timestamp: type: string format: date-time example: message: Invalid or inactive API key status: error statusCode: 401 code: authentication_failed details: null requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b timestamp: '2026-11-04T10:00:00.000Z' Error404: description: Nothing of yours has that ID or reference. content: application/json: schema: type: object properties: message: type: string description: What went wrong, for people. May be reworded. status: type: string example: error statusCode: type: integer description: The HTTP status. code: type: string description: A stable code to branch on. enum: - invalid_request - authentication_failed - permission_denied - not_found - conflict - rate_limited - internal_error - provider_error details: type: object nullable: true description: For validation errors, `errors` lists every problem. requestId: type: string description: Quote it when you contact us. timestamp: type: string format: date-time example: message: Transaction not found status: error statusCode: 404 code: not_found details: null requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b timestamp: '2026-11-04T10:00:00.000Z' Error429: description: Too many requests. Each key can make 120 a minute. content: application/json: schema: type: object properties: message: type: string description: What went wrong, for people. May be reworded. status: type: string example: error statusCode: type: integer description: The HTTP status. code: type: string description: A stable code to branch on. enum: - invalid_request - authentication_failed - permission_denied - not_found - conflict - rate_limited - internal_error - provider_error details: type: object nullable: true description: For validation errors, `errors` lists every problem. requestId: type: string description: Quote it when you contact us. timestamp: type: string format: date-time example: message: Too many requests. Slow down and try again shortly. status: error statusCode: 429 code: rate_limited details: null requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b timestamp: '2026-11-04T10:00:00.000Z' Error500: description: Something went wrong on our side. Retry with backoff. content: application/json: schema: type: object properties: message: type: string description: What went wrong, for people. May be reworded. status: type: string example: error statusCode: type: integer description: The HTTP status. code: type: string description: A stable code to branch on. enum: - invalid_request - authentication_failed - permission_denied - not_found - conflict - rate_limited - internal_error - provider_error details: type: object nullable: true description: For validation errors, `errors` lists every problem. requestId: type: string description: Quote it when you contact us. timestamp: type: string format: date-time example: message: Internal server error status: error statusCode: 500 code: internal_error details: null requestId: req_5f0c2a9b8d7e4c1f9a3b6d2e1c0f7a8b timestamp: '2026-11-04T10:00:00.000Z' securitySchemes: x-api-key: type: apiKey in: header name: x-api-key description: >- Your secret key. `fpay_test_…` keys use the sandbox; `fpay_live_…` keys move real money. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.