Sign in
Refunds

Refund a payment

Issue a full refund for a payment, identified by its transaction ID. The full remaining refundable amount is resolved automatically. Returns pending when the payment provider confirms the refund asynchronously.

post/v1/refunds

Request body

transaction_idstring required

The unique identifier of the transaction to refund in full.

Example request

{
  "transaction_id": "tran_1234567890"
}

Response

Successfully created the refund

status'pending' | 'requiresAction' | 'succeeded' | 'failed' | 'canceled' required

Status of the refund. pending and requiresAction represent non-terminal provider processing states.

Changes

Changed in 1 of the 4 revisions of this API.1