> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a top-up

> Returns one top-up, for polling its status. Returns 404 if it is not on the account.



## OpenAPI

````yaml /autogenerated/openapi/roqqett.openapi.json get /roqqett/top-ups/{topUpId}
openapi: 3.1.0
info:
  title: Roqqett API
  version: 2.0.0
  description: Version 2
  license:
    name: UNLICENSED
    url: https://docs.equalsmoney.com
servers:
  - url: https://api.equalsmoney.com/v2
    description: Production
security: []
paths:
  /roqqett/top-ups/{topUpId}:
    get:
      tags:
        - Top-ups
      summary: Retrieve a top-up
      description: >-
        Returns one top-up, for polling its status. Returns 404 if it is not on
        the account.
      operationId: findOneTopUp
      parameters:
        - name: topUpId
          in: path
          required: true
          schema:
            type:
              - string
            format: uuid
            maxLength: 36
            description: 'The ID of a checkout session: one payment journey.'
            example: 0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93
        - name: accountId
          in: query
          schema:
            description: The ID of the account to work with.
            type:
              - string
            example: F50091
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  id:
                    type:
                      - string
                    format: uuid
                    maxLength: 36
                    description: 'The ID of a checkout session: one payment journey.'
                    example: 0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93
                  status:
                    description: >-
                      OPEN until the payer authorises at their bank, PROCESSING
                      while the payment settles, then exactly one terminal
                      status.
                    type:
                      - string
                    enum:
                      - OPEN
                      - PROCESSING
                      - COMPLETED
                      - CANCELLED
                      - ABANDONED
                      - EXPIRED
                    example: OPEN
                  amount:
                    type:
                      - object
                    properties:
                      amount:
                        type:
                          - string
                        maxLength: 32
                        pattern: ^[0-9]+(\.[0-9]+)?$
                        description: >-
                          Decimal amount in major units, as a string. Never a
                          float.
                        example: '10000.00'
                      currencyCode:
                        type:
                          - string
                        enum:
                          - GBP
                          - EUR
                        description: >-
                          ISO-4217 code of a currency Roqqett can take payments
                          in: GBP over Faster Payments, EUR over SEPA Instant.
                        example: GBP
                    required:
                      - amount
                      - currencyCode
                    description: The total the payer pays, including any shipping.
                  locale:
                    type:
                      - string
                      - 'null'
                    pattern: ^[a-zA-Z]{2,3}(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|\d{3}))?$
                    description: >-
                      The locale the checkout is presented in. `null` when
                      neither the request nor the checkout set one, in which
                      case the payer's browser preference decides and en-GB is
                      the final fallback.
                    example: en-GB
                  checkoutUrl:
                    type:
                      - string
                    format: uri
                    maxLength: 2048
                    description: Where to send the payer to pay. Valid until `expiresAt`.
                    example: >-
                      https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93
                  returnUrl:
                    type:
                      - string
                      - 'null'
                    format: uri
                    maxLength: 2048
                    description: Where the payer is sent once the session ends.
                    example: https://shop.example.com/checkout/complete
                  paymentId:
                    type:
                      - string
                      - 'null'
                    format: uuid
                    maxLength: 36
                    description: The payment, once the payer has authorised one.
                    example: 9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34
                  expiresAt:
                    type:
                      - string
                    format: date-time
                    description: When an OPEN session expires.
                    example: '2026-10-02T13:00:00Z'
                  budgetId:
                    type:
                      - string
                    format: uuid
                    maxLength: 36
                    description: The budget being topped up.
                    example: 775596ae-2624-40af-a9dc-9756110a4a03
                  createdAt:
                    type:
                      - string
                    format: date-time
                    description: >-
                      The date the Resource was initially created. ISO 8601
                      format without milliseconds.
                  updatedAt:
                    type:
                      - string
                    format: date-time
                    description: >-
                      The date the Resource was last modified. ISO 8601 format
                      without milliseconds.
                required:
                  - id
                  - status
                  - amount
                  - locale
                  - checkoutUrl
                  - returnUrl
                  - paymentId
                  - expiresAt
                  - budgetId
                  - createdAt
                  - updatedAt
                example:
                  id: 0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93
                  status: OPEN
                  amount:
                    amount: '10000.00'
                    currencyCode: GBP
                  locale: en-GB
                  checkoutUrl: >-
                    https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93
                  returnUrl: https://shop.example.com/checkout/complete
                  paymentId: 9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34
                  expiresAt: '2026-10-02T13:00:00Z'
                  budgetId: 775596ae-2624-40af-a9dc-9756110a4a03
                  createdAt: '2019-08-24T14:15:22Z'
                  updatedAt: '2019-08-24T14:15:22Z'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
      security:
        - CommonAuth:
            - roqqett:top-ups:read:any
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl --request GET \
              --url 'https://api.equalsmoney.com/v2/roqqett/top-ups/{topUpId}?accountId={{accountId}}' \
              --header 'Authorization: <api-key>'
components:
  securitySchemes:
    CommonAuth:
      type: apiKey
      in: header
      name: Authorization

````