Refund a payment
Transactions
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
Refund a payment
Authorizations
API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.
Body
application/json
The transaction to refund in full.
The unique identifier of the transaction to refund in full.
Example:
"tran_1234567890"
Response
Successfully created the refund
Status of the refund. pending and requiresAction represent non-terminal provider processing states.
Available options:
pending, requiresAction, succeeded, failed, canceled Example:
"succeeded"