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

# Get Open Banking Payment Status

> Get the status and details of an Open Banking payment by payment ID



## OpenAPI

````yaml /api-reference/openapi.json get /payment/api/v1/ob/{payment_id}
openapi: 3.0.0
info:
  title: Carbn Connect API
  version: 1.0.0
  description: >-
    API documentation for Carbn Connect services including user onboarding, KYC,
    wallet management, and transfers.
servers:
  - url: https://api.carbnconnect.com
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /payment/api/v1/ob/{payment_id}:
    get:
      tags:
        - Open Banking
      summary: Get Open Banking Payment Status
      description: Get the status and details of an Open Banking payment by payment ID
      operationId: getOpenBankingPaymentStatus
      parameters:
        - name: payment_id
          in: path
          required: true
          schema:
            type: string
          example: ob_payment_123456789
          description: The unique identifier of the Open Banking payment
      responses:
        '200':
          description: Open Banking payment status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenBankingPaymentResponse'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized - API key is missing or invalid
        '404':
          description: Payment not found
      security:
        - ApiKeyAuth: []
components:
  schemas:
    OpenBankingPaymentResponse:
      type: object
      properties:
        amount:
          type: object
          properties:
            currency:
              type: string
              example: EUR
              description: Currency code (ISO 4217)
            value:
              type: number
              example: 2
              description: Payment amount
        bacs:
          type: string
          nullable: true
          example: null
          description: BACS reference (UK payments)
        iban:
          type: string
          nullable: true
          example: null
          description: IBAN of the recipient account
        reference:
          type: string
          example: H7rFnzjV5VU5kgrS6O
          description: Payment reference
        scheme:
          type: string
          example: SEPA_CREDIT_TRANSFER_INSTANT
          description: Payment scheme used
          enum:
            - SEPA_CREDIT_TRANSFER_INSTANT
            - SEPA_CREDIT_TRANSFER
            - FASTER_PAYMENTS
            - BACS
        status:
          type: string
          enum:
            - PAYMENT_STATUS_INPUT_NEEDED
            - PAYMENT_STATUS_AUTHORISING
            - PAYMENT_STATUS_INITIATED
            - PAYMENT_STATUS_EXECUTED
            - PAYMENT_STATUS_FAILED
            - PAYMENT_STATUS_BLOCKED
            - PAYMENT_STATUS_REJECTED
          example: PAYMENT_STATUS_INPUT_NEEDED
          description: >-
            Current payment status. PAYMENT_STATUS_INPUT_NEEDED: Awaiting user
            input. PAYMENT_STATUS_AUTHORISING: Being authorised.
            PAYMENT_STATUS_INITIATED: Authorised and in transit.
            PAYMENT_STATUS_EXECUTED: Funds have left payer's account.
            PAYMENT_STATUS_FAILED: System error (retryable).
            PAYMENT_STATUS_BLOCKED: Blocked by Plaid (retryable).
            PAYMENT_STATUS_REJECTED: Rejected by institution (terminal).
        end_to_end_id:
          type: string
          example: t1jl7t6a2b2f6940a94b26
          description: End-to-end identification
        last_status_update:
          type: string
          format: date-time
          example: YYYY-MM-DDTHH:MM:SS.sssZ
          description: Timestamp of last status update
        payment_id:
          type: string
          example: payment-id-production-7db7e6d7-9330-45f5-a28f-a96f1c9dab0c
          description: Unique payment identifier
        recipient_id:
          type: string
          example: recipient-id-production-f81ba3f8-0a28-4949-b3ac-e5919169cb0d
          description: Recipient identifier
        request_id:
          type: string
          example: fyKlyLpaIRq7683
          description: Request identifier
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Must be included in the x-api-key header.

````