Payment refund

Payment refund
  • Money refund can be used to partially return money to the same credit card used in the invoice payment or another, specified in the request.
  • Money refund can be performed multiple times, if the refunded sum does not exceed the amount of initial invoice payment.
  • If payment reversal is done for payment earlier, then refund is not allowed anymore.
  • Method: POST , URL: https://<BilderlingsPay processing url>/api/v<X>/invoice/refund/{invoice_ref}
Field Usage Description
amount M Reversal amount Decimal point – “.” Two decimal digits available (example: 200.00). (amount value > 0)
currency M Payment currency. 3 letters currency code.
pan Card number to refund money to. If it is not appointed, then money will be refunded to original payment card. (string)
expiry Card number expiration date in format MMYY. Mandatory if PAN is appointed.
  • Fields for signature calculation: <invoice_ref><amount><currency><X-Nonce><ShopPassword>
Request example:
 {
  "amount": 15.00,
  "currency": "EUR",
  "expiry": "0118",
  "pan": "4314220000000049"
 }
          
Money refund response is similar to reversal response:
Field Description
id transaction identifier
amount Transaction initial amount
payment_id Reversal payment identifier
target_payment_id Additional payment identifier
currency transaction currency
minor_amount value given to the lower currency units
created_date Invoice creating date (datetime)
updated_date Latest update date (datetime)
transaction_type REFUND
status Current status of invoice
error_code Code of error
error_message Description of error
shop_code Name of shop
invoice_ref Initial invoice reference
Money refund response example:
 {
  "id": 2752,
  "amount": 15.00,
  "payment_id": "19708749",
  "target_payment_id": null,
  "currency": "EUR",
  "minor_amount": 1500,
  "created_date": "2017-03-29T15:51:20.042Z",
  "updated_date": "2017-03-29T15:51:20.042Z",
  "transaction_type": "REFUND",
  "status": "SUCCEEDED",
  "error_code": null,
  "error_message": null,
  "shop_code": "TEST",
  "invoice_ref": "3GOitGNxc2sL6ClWbHW82oblQ"
 }