Funds transfers

Initiate Funds Transfer

post

Initiates a funds transfer transaction. This endpoint supports different types of transfers (e.g. P2P, P2M, M2M). The request payload must include transaction details and initiation data.

Authorizations

Body

transactionTypestring · enumRequiredExample: P2PPossible values:

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/payments/funds-transfers HTTP/1.1
Host: 127.0.0.1:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 639

{
  "transactionType": "P2P",
  "initiation": {
    "amount": {
      "amount": "2000760",
      "currency": "lyd"
    },
    "debtorAccount": {
      "schemeName": "iban",
      "identification": "LY5802500810085121000",
      "name": "Mohammed Mahmoud Altaleesi"
    },
    "creditorAccount": {
      "schemeName": "iban",
      "identification": "LY5802500810085121000",
      "name": "Ahmad Mohammed Houssain"
    },
    "creditorInstitution": {
      "name": "Bank Name",
      "code": "01"
    },
    "additionalData": {
      "billNumber": "OPTIONAL",
      "mobileNumber": "OPTIONAL",
      "storeLabel": "OPTIONAL",
      "referenceLabel": "OPTIONAL",
      "customerLabel": "OPTIONAL",
      "terminalLabel": "OPTIONAL",
      "purposeOfTransaction": "OPTIONAL"
    },
    "description": "Text explaining the reason of this payment"
  }
}

P2P Funds Transfer RequestP2M Funds Transfer RequestM2M Funds Transfer Request

{
  "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": "P2P",
    "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": []
    },
    "description": "Text explaining the reason of this payment"
  }
}

Get Funds Transfer Status

get

Retrieves the status and details of a funds transfer transaction using its UUID. Query parameters (paymentReference and transactionTimestamp) may be used for additional filtering.

Authorizations

Path parameters

uuidstringRequired

Unique identifier of the funds transfer transaction

Query parameters

paymentReferencestringOptional

Payment reference of the transaction

transactionTimestampintegerOptional

Transaction timestamp

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/payments/funds-transfers/{uuid} HTTP/1.1
Host: 127.0.0.1:8080
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "uuid": "62c78f0e-0e26-49e4-bd04-6553bede9fe3",
    "paymentReference": "1ce11b3e-b376-4318-b887-9a189631aad2",
    "transactionType": "P2P",
    "description": "Text explaining the reason of this payment",
    "transactionDateTime": "2024-05-31T21:04:02+00:00",
    "transactionTimestamp": 1717189442,
    "valueDateTime": "2024-05-31T21:04:02+00:00",
    "status": {
      "name": "completed",
      "code": "01",
      "message": ""
    },
    "debtorAmount": {
      "currency": "lyd",
      "amount": "1104000",
      "fees": "4000"
    },
    "creditorAmount": {
      "currency": "lyd",
      "amount": "1100000",
      "fees": "0"
    },
    "debtorAccount": {
      "schemeName": "IBAN",
      "identification": "0012010001491111",
      "name": "Ahmad Mahmoud"
    },
    "creditorAccount": {
      "schemeName": "IBAN",
      "identification": "001205000011111",
      "name": "Mohammed Khaled"
    },
    "creditorInstitution": {
      "name": "Jumhouria Bank",
      "code": "002"
    },
    "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": {
        "authNum": "151512515152",
        "refNum": "347268358194",
        "respcode": "",
        "respcodeDesc": ""
      }
    }
  }
}