Release NotesAnnouncementsBlogFAQSupport
API Reference

Create a refund

post
https://scl-sandbox.dev.clover.com/v1/refunds

Creates a new refund that must be associated with an existing charge. Refunds are applied to the source used for the original payment. Partial refunds are allowed up to the original charge amount.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

An object describing a refund to be applied

string
required

Unique identifier (ID) of the charge to refund. The charge parameter is available in the Get charges and Get a charge endpoints.

int64
≥ 1

Refund amount in cents from the remaining, unrefunded amount of the charge.

string

Unique dentifier (ID), such as an invoice or purchase order (PO) number, that is passed to the merchant's gateway and displays in settlement records. Format: Supported for US—alphanumeric characters with in-between spaces Length: Max 12, including spaces and alphanumeric characters.

string
enum

Reason for the refund.

Allowed:
Headers
string
required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Responses

Updated 3 months ago

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

Updated 3 months ago