Create a refund.

Creates a refund. (see note)

Use with caution. This action creates an Unlinked Refund that is not associated with an
Podium Invoice or Payment. This current implementation only works
with a Podium Payment Card Reader, reading the customer's credit card data
before debiting the refunded amount.

Balance requirements. This action requires that your account have on hand an amount
equal to or greater than the amount of the refund. The amount for this refund will be
deducted from the amount still to pay out from the account. If the account does not have
sufficient funds, the refund will fail.

Upcoming change: When this resource supports refunding a Podium Invoice,
/invoices/uid/refund is planned to be deprecated.

Required scope: write_payments.

Body Params

Create refund params

uuid

Podium unique identifier for bank account.

integer
required
≥ 1

Amount to refund to the customer, represented in cents.

string
required

Identifies the Messenger channel. Must be a valid email address or a phone number. Non-US/Canada numbers must include the country code (e.g. +61 for AUS)

string
required

Name of the customer who will receive the refund.

uuid
required

Podium unique identifier for location.

uuid
required

Podium unique identifier for card reader.

string
enum
required

Generic reason for why the refund was initiated.

Allowed:
Responses

Callback
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json