Overview

Refunds are transactions that return funds to a customer from a previous order.

The Refunds Data Model simplifies the handling and retrieval of Refunds data for your application. The model provides a unified representation of refunds data across different platforms, enabling you to easily access and manage refunds data from different platforms.

• Unified Refunds properties: The model provides a unified representation of refunds properties across different platforms, enabling you to easily access and manage refunds data from different platforms.
• Comprehensive refunds information: The model provides a comprehensive representation of refunds data, including all the properties and relationships that you can retrieve for a refund.

Attributes

Refund Attributes

Property	Type	Description
rootfi_id	integer	The RootFi ID of the refund
rootfi_created_at	string	The ISO 8601 timestamp at which the record was created in RootFi
rootfi_updated_at	string	The ISO 8601 timestamp at which the record was last updated in RootFi
rootfi_company_id	integer	The RootFi company ID associated with the refund
platform_id	string	The Platform’s ID for the Refund
platform_unique_id	string	The platform’s unique identifier for the refund
created_at	string	The date and time the refund was created
amount	number	The amount of the refund
currency_id	string	The currency of the refund
payment_id	string	The payment id of the refund
description	string	The description of the refund
status	enum	The status of the refund (PENDING, SUCCESS, FAILED)

Properties Supported

Property	Type	Description
platform_id	string	The Platform’s ID for the Refund
created_at	string	The date and time the refund was created
amount	number	The amount of the refund
currency_id	string	The currency of the refund
payment_id	string	The payment id of the refund
description	string	The description of the refund
status	enum	The status of the refund. Allowed values are PENDING, SUCCESS, FAILED

The Refunds Response Object

{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "re_123456",
  "created_at": "2024-01-22T05:07:31.000Z",
  "amount": 50.00,
  "currency_id": "USD",
  "payment_id": "pay_123456",
  "description": "Refund for damaged item",
  "status": "SUCCESS"
}