Payment
post/payment/{id}/credit

Request

  • Base URL
    https://api.centrobill.com
  • URL
    https://api.centrobill.com/payment/{id}/credit
  • Auth
    API key in header Authorization

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

sendIpnboolean

Send an IPN to the merchant about the credit. If <b>false</b>, the refund/void is processed, but no IPN is sent. Set to <b>true</b> by default

Example request

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

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"
      }
    }
  }
}

Changes

    • warning

      added the new blik enum value to the // response property for the response status

    • warning

      added the new cashapp enum value to the // response property for the response status

    • warning

      added the new duitnow enum value to the // response property for the response status

    • warning

      added the new gojekid enum value to the // response property for the response status

    • warning

      added the new neteller enum value to the // response property for the response status

    • warning

      added the new offlinebanking enum value to the // response property for the response status

    • warning

      added the new pago enum value to the // response property for the response status

    • warning

      added the new payconiq enum value to the // response property for the response status

    • warning

      added the new paynow enum value to the // response property for the response status

    • warning

      added the new promptpay enum value to the // response property for the response status

    • warning

      added the new rapid enum value to the // response property for the response status

    • warning

      added the new toss enum value to the // response property for the response status

    • warning

      added the new trustly enum value to the // response property for the response status

    • warning

      added the new viettelpay enum value to the // response property for the response status

    • info

      added the new optional request property

    • info

      removed the banktransferChile enum value from the // response property for the response status