Skip to content

Latest commit

 

History

History
38 lines (32 loc) · 1.84 KB

RefundRequest.md

File metadata and controls

38 lines (32 loc) · 1.84 KB

WorldnetPayments::RefundRequest

Properties

Name Type Description Notes
channel String [optional]
terminal String The terminal number assigned by the gateway.
operator String The operator who initiated the transaction. If not sent in the request, this field will be automatically populated with the API Key alias. [optional]
order_id String A unique identifier for the order assigned by the merchant.
currency String The currency of the transaction. A 3-letter code as per the ISO 4217 standard.
refund_amount Float The total amount to be refunded.
refund_reason String The reason why the refund is being performed.
customer Customer [optional]
customer_account Payload [optional]
ip_address IpAddress [optional]
additional_data_fields Array<CustomField> List of custom fields which are used to add extra information to transactions. Their values are going to be stored and used for the requests sent to the terminal's receipt and validation webhooks.<br />To understand more visit the section regarding Special Fields and Parameters. [optional]

Example

require 'worldnet_payments'

instance = WorldnetPayments::RefundRequest.new(
  channel: null,
  terminal: null,
  operator: null,
  order_id: null,
  currency: null,
  refund_amount: null,
  refund_reason: null,
  customer: null,
  customer_account: null,
  ip_address: null,
  additional_data_fields: null
)