Funds transfers | CBL

Initiate Funds Transfer

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.

post

/api/v1/payments/funds-transfers

Authorizations

Body

transactionTypeenumrequired

Example: P2P

Options: P2P, P2M, M2M

initiationobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://127.0.0.1:8080/api/v1/payments/funds-transfers' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"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":"<p>Text explaining the reason of this payment</p>"}}'

201

default

{
  "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": "<p>Text explaining the reason of this payment</p>"
  }
}

Funds transfer initiated successfully

Get Funds Transfer Status

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

get

/api/v1/payments/funds-transfers/{uuid}

Authorizations

Path parameters

uuidstringrequired

Unique identifier of the funds transfer transaction

Query parameters

paymentReferencestring

Payment reference of the transaction

transactionTimestampinteger

Transaction timestamp