v1

latestOpenAPI 3.1.02026-07-26490301.4 KB

Payment

Credit

post/payment/{id}/credit

Path parameters

idstring required

Transaction that should be credited

Headers

X-Request-IDstring

Unique ID of request

Request body

amountnumber double

If the parameter is not passed, full amount is credited

reasonstring required

Reason of operation

Example request

{
  "amount": 9.99,
  "reason": "Retention offer"
}

Response

Created

Example response

{
  "payment": {
    "description": "APPROVED",
    "action": "credit",
    "mode": "refund",
    "status": "success",
    "amount": 9.99,
    "currency": "USD",
    "transactionId": "12345",
    "parentTransactionId": "735101832",
    "descriptor": "centrohelp.com",
    "source": {
      "method": "card",
      "number": "4024******6348",
      "brand": "visa",
      "bankName": "BENDIGO AND ADELAIDE BANK, LTD",
      "bankCountry": "AUS",
      "paymentAccountId": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
      "timestamp": {
        "dateTime": "2020-04-17 13:43:02",
        "timezone": "UTC+02.00",
        "unixTime": "1637063718"
      }
    }
  }
}