Create a refund - WooshPay OpenAPI

When you create a new refund, you must specify a PaymentIntent object on which to create it. Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged. You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded.

Once entirely refunded, a charge can’t be refunded again. This method will return an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic YWRtaW46MTIzNDU2

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

amount

string

optional

A positive integer in cents representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge.

metadata

object

optional

A set of key-value pairs that you can attach to a Refund object. This can be useful for storing additional information about the refund in a structured format. You can unset individual keys if you POST an empty value for that key. You can clear all keys if you POST an empty value for metadata

payment_intent

string

optional

ID of the PaymentIntent to refund.

reason

enum<string>

optional

String indicating the reason for the refund. If set, possible values are duplicate , fraudulent , and requested_by_customer.

Allowed values:

duplicatefraudulentrequested_by_customerresolved_dispute

Example

{
  "reason": "requested_by_customer",
  "payment_intent": "pi_1787730829493927936"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

string

optional

Unique identifier for the object, like 're_xxxx'.

object

string

optional

'refund'

amount

integer

optional

Amount, in cents.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

currency

string

optional

Three-letter ISO currency code, in lowercase. Must be a supported currency.

metadata

object

optional

Set of key-value pairs that you can attach to an object.

payment_intent

string

optional

ID of the PaymentIntent that was refunded.

reason

enum<string>

optional

Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer)

Allowed values:

duplicatefraudulentrequested_by_customerexpired_uncaptured_chargeresolved_dispute

status

string

optional

Status of the refund. For credit card refunds, this can be pending, succeeded, or failed. For other types of refunds, it can be pending, succeeded, failed, or canceled.

description

string

optional

An arbitrary string attached to the object. Often useful for displaying to users.

failure_reason

enum<string>

optional

If the refund failed, the reason for refund failure if known. Possible values are lost_or_stolen_card, expired_or_canceled_card, or unknown.

Allowed values:

lost_or_stolen_cardexpired_or_canceled_cardunknown

Example

{
  "id": "string",
  "object": "string",
  "amount": 0,
  "created": 0,
  "currency": "string",
  "metadata": {},
  "payment_intent": "string",
  "reason": "duplicate",
  "status": "string",
  "description": "string",
  "failure_reason": "lost_or_stolen_card"
}