CBL | DevPortal
  • Welcome to the Central Bank of Libya Developer Portal | DevPortal
  • LYPay
    • LYPay Instant Payment System
    • Regulatory Guidelines & Compliance
    • Accounting & Settlement in LYPay
    • LYPay Instant Payment System – Technical Overview
    • API Documentation
      • About the APIs
      • API reference
        • Webhooks
        • Auth
          • Revoke
        • Api
          • V1
            • Miscs
              • Institutions
              • Transaction status
            • Payments
              • Funds transfers
                • Refund
                • Confirm
              • Debited funds transfers
              • Credited funds transfers
                • By internal merchant reference
              • Details
            • Auth
              • Token
              • Password
                • Reset
      • Specification
    • NUMO QR Code Standards
  • Contact & Support
Powered by GitBook
On this page
  1. LYPay
  2. API Documentation
  3. API reference
  4. Api
  5. V1
  6. Payments
  7. Credited funds transfers

By internal merchant reference

PreviousCredited funds transfersNextDetails

Get Funds Transfer by Internal Merchant Reference

get

Retrieves the current status of a funds transfer transaction based on the provided internal merchant reference.

Authorizations
Query parameters
internal_merchant_referencestringRequired

Internal merchant reference string

Example: xxxx
Responses
200
Funds transfer details retrieved successfully
application/json
default
An error response object
application/json
get
GET /api/v1/payments/credited-funds-transfers/by-internal-merchant-reference HTTP/1.1
Host: 127.0.0.1:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": {
    "uuid": "3f9d6843-6329-4263-a465-7edc0f202c4e",
    "paymentReference": "d7c14ded-d0e1-4541-80c5-53fffa6e5e5",
    "status": {
      "name": "acknowledged",
      "code": "01",
      "message": "SWITCH CODE + SWITCH MESSAGE"
    },
    "transactionDateTime": "2024-05-17T17:18:02+00:00",
    "transactionTimestamp": 1715966282,
    "valueDateTime": "2024-05-17T17:18:02+00:00",
    "transactionType": "P2M",
    "debtorAmount": {
      "currency": "lyd",
      "amount": "2000760",
      "fees": "10000"
    },
    "creditorAmount": {
      "currency": "lyd",
      "amount": "2000760",
      "fees": "100"
    },
    "debtorAccount": {
      "schemeName": "iban",
      "identification": "DE89370400440532013000",
      "name": "Ahmad"
    },
    "creditorAccount": {
      "schemeName": "iban",
      "identification": "DE89370400440532013001",
      "name": "Mohammed"
    },
    "creditorInstitution": {
      "name": "JBANK",
      "code": "01"
    },
    "additionalData": {
      "billNumber": "OPTIONAL",
      "mobileNumber": "OPTIONAL",
      "storeLabel": "OPTIONAL",
      "referenceLabel": "OPTIONAL",
      "customerLabel": "OPTIONAL",
      "terminalLabel": "OPTIONAL",
      "purposeOfTransaction": "OPTIONAL"
    },
    "numoNotice": {
      "debit": {
        "authNum": "14412214412",
        "refNum": "347268358194",
        "respcode": "0",
        "respcodeDesc": ""
      },
      "credit": {
        "authNum": "151512515152",
        "refNum": "347268358194",
        "respcode": "0",
        "respcodeDesc": ""
      },
      "reverse": []
    },
    "internalMerchantReference": "xxxx",
    "description": "Text explaining the reason of this payment"
  }
}