Skip to main content
POST
Refund a payment

Authorizations

x-api-key
string
header
required

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.

transaction_id
string
required

The unique identifier of the transaction to refund in full.

Example:

"tran_1234567890"

Response

Successfully created the refund

status
enum<string>
required

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

Available options:
pending,
requiresAction,
succeeded,
failed,
canceled
Example:

"succeeded"