Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
REFUNDS

Get refunds list

Returns a list of all existing refunds. The newest refund is first in the list. The ten most recent refunds appear by default on the charge object.

get/v1/refunds

Query parameters

chargestring

Retrieve refunds applied to a specific charge.

gtstring date-time

Displays results when the created field is greater than the current value.

gtestring date-time

Displays results when the created field is greater than or equal to the current value.

ltstring date-time

Displays results when the created field is less than the current value.

ltestring date-time

Displays results when the created field is less than or equal to the current value.

List filter based on the object's created field. The value can be a string with a Unix timestamp (in milliseconds) or a dictionary of multiple options describing a time range.

ending_beforestring

Cursor used in pagination. The ending_before object ID sets your place in the list. For example, if you receive 100 objects in a list starting with obj_bar, add ending_before=obj_bar in your subsequent request to retrieve the previous page of the list.

limitinteger

The number of objects returned by the request, ranging between 1 and 100. The default value is 10.

starting_afterstring

Cursor used in pagination. The starting_after object ID sets your place in the list. For example, if you receive 100 objects in a list starting with obj_foo, add starting_after=obj_foo in your subsequent request to retrieve the next page of the list.

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

Successful response. Refunds are displayed.

idstring required

Refund identifier.

amountinteger required

Refund amount from the balance of unrefunded amount of the charge. Format: Cents

createdinteger required

Displays results based on the object's created field. Values: String with a Unix timestamp (in milliseconds). Dictionary of multiple options describing a time range.

currencystring required

Three-letter ISO 4217 currency code.

descriptionstring

Description about the refund.

external_reference_idstring

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

failure_reason'lost_or_stolen_card' | 'expired_or_canceled_card' | 'unknown'

Reason of the cancellation of the refund.

chargestring required

Charge identifier.

metadataobject required

Indicates whether a US merchant with the gateway group Ids 40001 or 10001, and merchant category codes (MCC) 6012 or 6051 can process Visa® consumer debit transactions that have an existing debt. Values: True - Merchant can process transactions that have an existing debt. False - Default; Transactions do not have an existing debt.

object'refund' required

Object of the refund.

reason'duplicate' | 'fraudulent' | 'requested_by_customer' nullable

Reason for the refund.

receipt_numberstring nullable

Transaction receipt number that appears on the receipt emailed for this charge

status'succeeded (card or non-card)' | 'failed (card or non-card)' | 'pending (non-card only)' | 'canceled (non-card only)' nullable required

Status of the refund. Values: For credit cards - succeeded or failed For other methods - pending, succeeded, failed, or canceled