Skip to main content

Transaction QR Codes API

Overview​

The Transaction QR Codes API provides a comprehensive solution for generating, managing, and processing QR codes for financial transactions. This API enables users to create QR codes that can be scanned by other users to initiate payments, making it easy to facilitate peer-to-peer transactions and merchant payments.

Key Features​

  • QR Code Generation: Create unique QR codes with transaction details
  • QR Code Scanning: Scan and retrieve transaction information from QR codes
  • Status Management: Track and update QR code status throughout the transaction lifecycle
  • Expiry Handling: Automatic expiration of QR codes after specified time
  • Transaction Linking: Associate QR codes with actual transactions

API Endpoints​

1. Generate Transaction QR Code​

  • Method: POST
  • Endpoint: /gafapay/v3/user/transaction_qr/generate
  • Purpose: Create a new QR code for a transaction
  • Key Features:
    • Set transaction amount and expiry time
    • Generate unique QR code string
    • Assign transaction code type

2. Scan Transaction QR Code​

  • Method: POST
  • Endpoint: /gafapay/v3/user/transaction_qr/scan
  • Purpose: Scan and retrieve details from an existing QR code
  • Key Features:
    • Decode QR code string
    • Retrieve transaction information
    • Update scanner information

3. Update Transaction QR Code​

  • Method: PUT
  • Endpoint: /gafapay/v3/user/transaction_qr
  • Purpose: Update QR code status and properties
  • Key Features:
    • Change QR code status
    • Link to actual transactions
    • Update metadata

4. Get Transaction QR Code​

  • Method: GET
  • Endpoint: /gafapay/v3/user/transaction_qr/{id}
  • Purpose: Retrieve detailed information about a specific QR code
  • Key Features:
    • Complete QR code details
    • Transaction history
    • Status tracking

QR Code Lifecycle​

graph TD
    A[Generate QR Code] --> B[QR Code Generated]
    B --> C[QR Code Scanned]
    C --> D[QR Code Processed]
    D --> E[Transaction Completed]
    
    B --> F[QR Code Expired]
    C --> G[QR Code Cancelled]
    
    F --> H[QR Code Invalid]
    G --> H

Status Types​

  • GENERATED: QR code has been created and is ready for scanning
  • PROCESSED: QR code has been scanned and processed
  • EXPIRED: QR code has passed its expiry time
  • CANCELLED: QR code has been manually cancelled

Support​

For technical support or questions about the Transaction QR Codes API, please contact the GafaPay development team.