POST
/
transactions
/
refund-transactions
/
{parent-transaction-id}
curl --request POST \
  --url https://base_url/api/v1/transactions/refund-transactions/{parent-transaction-id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "refund_type": "FULL",
  "line_items": [
    {
      "id": "<string>"
    }
  ],
  "source_platform": "RAZORPAY"
}'
{
  "data": {
    "id": "2535af08-a139-4d0c-9827-1651e46dfbcf"
  },
  "message": "Successfully created refund transaction."
}
Refund transactions are a preview feature. This interface may change in future releases.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
parent-transaction-id
string
required

The unique identifier of the transaction to generate a refund for.

Body

application/json
​
refund_type
enum<string>
required

Whether to refund an entire transaction or only specific line items.

Available options:
FULL,
PARTIAL
​
line_items
object[]
required

The line items to refund. Required if refund_type is PARTIAL.

​
source_platform
enum<string>

Platform where this entity originated.

Available options:
RAZORPAY,
ZOHO_BOOKS,
QUICKBOOKS_SANDBOX,
QUICKBOOKS,
XERO,
TALLY,
SAGE_CLOUD_ACCOUNTING,
MS_DYNAMICS_365,
SAGE_ZA_CLOUD_ACCOUNTING,
MYOB_BUSINESS,
WAVE,
ODOO_ACCOUNTING,
NETSUITE,
WAFEQ,
MEKARI_JURNAL,
BUSY,
ROOTFI_SANDBOX,
QOYOD,
SHOPIFY,
STRIPE,
PAYPAL,
HUBSPOT,
ZOHO_CRM,
PIPEDRIVE,
WOOCOMMERCE,
OTHER

Response

200
application/json
Transaction creation response
​
data
object
​
message
string
Example:

"Successfully created refund transaction."