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>"
    }
  ]
}'
{
  "data": {
    "id": "2535af08-a139-4d0c-9827-1651e46dfbcf"
  },
  "message": "Successfully created refund transaction."
}

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[]

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

Response

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

"Successfully created refund transaction."

Refund TransactionsBulk Transactions