Refund Request

Submit a refund request for a completed WiPay transaction. Each transaction can only have one active refund request.

Endpoint

POST /transactions/{transaction_id}/refund

Access	Requirement
Authenticated	Yes
Required Scope	`wapi-transactions-refund-request`, or `wapi-transactions-all`
Rate Limit	15 requests per minute

Request

Headers

Header	Value
`Accept`	`application/json`
`Authorization`	`Bearer <access_token>`
`X-WAPI-Key`	`wapi_live_<kid>_<secret>` or `wapi_test_<kid>_<secret>`

Send exactly one of Authorization or X-WAPI-Key.

Path Parameters

Parameter	Type	Required	Description
`transaction_id`	string	Yes	The transaction ID to request a refund for

No request body required.

Responses

201 Created

{
  "message": "Refund request successfully created."
}

400 Bad Request

Invalid transaction id

{
  "message": "The selected transaction id is invalid."
}

Transaction status cannot be refunded

{
  "message": "The selected transaction id has invalid status."
}

Refund already requested

{
  "message": "The selected transaction id has an existing refund request."
}

Already refunded

{
  "message": "The selected transaction id has already been refunded."
}

Refund not allowed

{
  "message": "The selected transaction id cannot be refunded."
}

401 Unauthorized

{
  "message": "Unauthorized"
}

403 Forbidden

Insufficient permissions

{
  "message": "Forbidden"
}

Refunding account has insufficient balance

{
  "message": "Insufficient funds on WiPay account to request refund."
}

Invalid scopes

{
  "message": "Invalid scope(s) provided."
}

Example

curl -X POST "https://ttsb.wipayfinancial.com/wapi/transactions/SB-32-55179-oId_123-Abc1-20260202232018/refund" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access_token>"

On this page