Skip to main content
Vindicia Knowledge Center

The refund object

The refund object

Attributes

Name Type Description
object string Value is “Refund”
id string A merchant-specified unique identifier. Optionally, this object can be identified by its vid. Excepting externally “reported” refunds, this is ready-only, this field will be assigned by CashBox.
vid string A Globally Unique Identifier (GUID) for this object. This field is created by CashBox.
created datetime The date/time at which the refund was requested.
transaction Transaction The transaction to refund.
refund_items RefundItem[] For item-level refunds, specifies the transaction items to refund with details.
refund_distribution_strategy string Defines strategy for distributing refund amount across the original TransactionItems. Default: None
amount decimal Amount of the refund. Must be positive (non-zero) and less than or equal to the as-yet-un-refunded balance of the specified transaction. Ignored if refundItems are specified.
amount_includes_tax boolean whether the amount is tax-inclusive or -exclusive
currency string ISO 4217 Currency Code of this transaction; defaults to USD.
metadata hash A set of key/value pairs that you can attach to an object. Useful for storing additional information.
reference_string string Read-only. Information provided by payment processor.
note string Free-form merchant-specified notes about refund.
token_action enum Action to take with any Tokens paid on transaction. Default: None. Values can be CancelNegativeBalance,CancelZeroBalance,None
credit Credit Read-only. Credits reversed by refund.
status enum Processing status of refund. Values can be Complete,Failed,Processing,Reported
  • cURL
  • Java
Example Object
{
    "object": "Refund",
    "id": "FLX200001561",
    "vid": "64a6bad051bdf489c7cf90ed52fca549c0048d3d",
    "created": "2016-05-24T17:50:47-07:00",
    "transaction": {`...`},
    "refund_distribution_strategy": "None",
    "amount": 14.99,
    "amount_includes_tax": false,
    "currency": "USD",
    "metadata": {`...`},
    "note": "Refund 14.99USD",
    "token_action": "None",
    "status": "Complete"
}
         
{
    "object": "Refund",
    "id": "FLX200001561",
    "vid": "64a6bad051bdf489c7cf90ed52fca549c0048d3d",
    "created": "2016-05-24T17:50:47-07:00",
    "transaction": {`...`},
    "refund_distribution_strategy": "None",
    "amount": 14.99,
    "amount_includes_tax": false,
    "currency": "USD",
    "metadata": {`...`},
    "note": "Refund 14.99USD",
    "token_action": "None",
    "status": "Complete"
}
          

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top