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

# Consulter un lien de paiement

> Récupérez la configuration et l'utilisation d'un lien de paiement.

```bash cURL theme={null}
curl --request GET \
  --url https://api.bizconnectpay.com/api/v1/payment-links/b80736cf-514a-462b-b110-b04c6031b64a \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <access_token>'
```

```json 200 OK theme={null}
{
  "success": true,
  "data": {
    "id": "b80736cf-514a-462b-b110-b04c6031b64a",
    "reference": "BCP-LNK-01JACC0N",
    "amount": "12500.0000",
    "currency": "XAF",
    "country": "CM",
    "description": "Facture octobre",
    "status": "ACTIVE",
    "max_uses": 1,
    "use_count": 0,
    "checkout_url": "https://pay.bizconnectpay.com/link/0PKOW1IM14",
    "metadata": {
      "client_reference": "INV-2026-1008"
    },
    "expires_at": "2026-10-31T23:59:59.000000Z"
  },
  "meta": {
    "correlation_id": "b39b6c1d-d682-4f61-8839-93b8a9bd76e7"
  }
}
```


## OpenAPI

````yaml openapi.json GET /payment-links/{paymentLink}
openapi: 3.1.0
info:
  title: BizConnectPay API
  version: 1.0.0
  description: >-
    API serveur-à-serveur pour les collectes, décaissements, transactions,
    remboursements, liens de paiement et cartes virtuelles.
servers:
  - url: https://api.bizconnectpay.com/api/v1
    description: Passerelle API BizConnectPay
security:
  - bearerAuth: []
tags:
  - name: Authentification
  - name: Services
  - name: Collectes
  - name: Transactions
  - name: Décaissements
  - name: Remboursements
  - name: Liens de paiement
  - name: Porteurs de carte
  - name: Cartes virtuelles
paths:
  /payment-links/{paymentLink}:
    get:
      tags:
        - Liens de paiement
      summary: Consulter un lien de paiement
      operationId: getPaymentLink
      parameters:
        - name: paymentLink
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    Success:
      description: Requête traitée
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessEnvelope'
    NotFound:
      description: Ressource introuvable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    SuccessEnvelope:
      type: object
      properties:
        success:
          type: boolean
          const: true
        data: {}
        meta:
          $ref: '#/components/schemas/Meta'
    ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          const: false
        data:
          type: object
          properties:
            error:
              type: object
              properties:
                code:
                  type: string
                message:
                  type: string
                details:
                  type:
                    - object
                    - array
        meta:
          $ref: '#/components/schemas/Meta'
    Meta:
      type: object
      properties:
        correlation_id:
          type:
            - string
            - 'null'
          format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.