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

# Verify a checkout by reference

> Retrieves the details and current status of a checkout using its reference.
This endpoint is useful for checking the payment status and retrieving customer information after a payment is completed.




## OpenAPI

````yaml api-reference/openapi-3.1.yml get /v1/checkouts/{reference}
openapi: 3.0.3
info:
  title: Mobipurse API
  description: >
    Mobipurse is a universal wallet platform that enables merchants to accept
    payments and make disbursements to customers across any country.


    ## Authentication

    All API requests require authentication using an API key. Include your API
    key in the `x-api-key` header.


    ## Environments

    - **Staging**: `https://staging-api.mobipurse.com`

    - **Production**: `https://api.mobipurse.com`


    ## Support

    - Email: support@mobipurse.com

    - Dashboard: https://mobipurse.com
  version: 1.0.0
  contact:
    email: support@mobipurse.com
servers:
  - url: https://staging-api.mobipurse.com
    description: Staging server
  - url: https://api.mobipurse.com
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Checkouts
    description: Operations for creating and managing payment checkouts
  - name: Disbursements
    description: Operations for making disbursements to recipients
paths:
  /v1/checkouts/{reference}:
    get:
      tags:
        - Checkouts
      summary: Verify a checkout by reference
      description: >
        Retrieves the details and current status of a checkout using its
        reference.

        This endpoint is useful for checking the payment status and retrieving
        customer information after a payment is completed.
      operationId: verifyCheckout
      parameters:
        - name: reference
          in: path
          required: true
          description: The unique reference of the checkout to verify
          schema:
            type: string
          example: DMBC20251110154056OSPHM
      responses:
        '200':
          description: Checkout details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyCheckoutResponse'
              examples:
                success:
                  summary: Successful checkout verification
                  value:
                    statusCode: 200
                    data:
                      userId: 68fa3195501b6057c4d09f54
                      merchant:
                        name: Valerie Tremblay
                      country: CI
                      currency: XOF
                      amount: 200000
                      fee: 9600
                      webhookURL: >-
                        https://webhook.site/100ebe83-961d-4096-8741-05772dafcfa1
                      redirectURL: https://mobipurse.com
                      reference: DMBC20251110154056OSPHM
                      merchantsReference: DMBC20251110154056OSPHM
                      status: success
                      createdAt: '2025-11-10T15:40:56.754Z'
                      updatedAt: '2025-11-10T15:41:15.263Z'
                      customer:
                        id: 69084137da4cde9706ab5c48
                        phoneNumber: '2250538102473'
                        name: Sample User
                      id: 69120788556412fad695d139
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    VerifyCheckoutResponse:
      type: object
      properties:
        statusCode:
          type: integer
          example: 200
        data:
          type: object
          properties:
            id:
              type: string
              description: Unique identifier for the checkout
              example: 69120788556412fad695d139
            userId:
              type: string
              description: Merchant's user ID
              example: 68fa3195501b6057c4d09f54
            merchant:
              type: object
              properties:
                name:
                  type: string
                  example: Valerie Tremblay
            country:
              type: string
              example: CI
            currency:
              type: string
              example: XOF
            amount:
              type: integer
              example: 200000
            fee:
              type: integer
              example: 9600
            webhookURL:
              type: string
              format: uri
              example: https://webhook.site/100ebe83-961d-4096-8741-05772dafcfa1
            redirectURL:
              type: string
              format: uri
              example: https://mobipurse.com
            reference:
              type: string
              example: DMBC20251110154056OSPHM
            merchantsReference:
              type: string
              example: DMBC20251110154056OSPHM
            status:
              type: string
              enum:
                - pending
                - success
                - failed
              example: success
            customer:
              type: object
              properties:
                id:
                  type: string
                  example: 69084137da4cde9706ab5c48
                phoneNumber:
                  type: string
                  example: '2250538102473'
                name:
                  type: string
                  example: Sample User
            createdAt:
              type: string
              format: date-time
              example: '2025-11-10T15:40:56.754Z'
            updatedAt:
              type: string
              format: date-time
              example: '2025-11-10T15:41:15.263Z'
    Error:
      type: object
      properties:
        statusCode:
          type: integer
          example: 400
        message:
          type: string
          example: Invalid request parameters
        error:
          type: string
          example: Bad Request
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 401
            error: Invalid API key
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 404
            error: Resource not found
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 500
            error: Internal Server Error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Generate this from your Mobipurse dashboard
        under Settings → API Keys.

````