Refund

Initiate Funds Transfer Refund (M2P)

Initiates a refund for a funds transfer. The refund amount must be equal to or less than the original transaction amount.

post

/api/v1/payments/funds-transfers/{UUID}/refund

Authorizations

Path parameters

UUIDstringrequired

Unique identifier of the original funds transfer transaction

Body

paymentReferencestringrequired

Example: 6645ef40eb9fe

transactionTimestampintegerrequired

Example: 1715859264

amountstringrequired

Example: 40000

descriptionstring

Example: Text explaining the reason of this payment

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://127.0.0.1:8080/api/v1/payments/funds-transfers/{UUID}/refund' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"paymentReference":"6645ef40eb9fe","transactionTimestamp":1715859264,"amount":"40000","description":"<p>Text explaining the reason of this payment</p>"}'

200

default

200

{
  "data": {
    "uuid": "3f9d6843-6329-4263-a465-7edc0f202c4e",
    "paymentReference": "d7c14ded-d0e1-4541-80c5-53fffa6e5e5",
    "status": {
      "name": "completed",
      "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": {},
    "numoNotice": {},
    "description": "Text explaining the reason of this payment"
  }
}

Refund processed successfully