Create a refund

POST

/v1/refunds

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 *****************

Header Params

Body Params application/json

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apitest.wooshpay.com/v1/refunds' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "reason":"requested_by_customer",
    "payment_intent":"pi_1787730829493927936"
}'

Responses

🟢200OK

application/json

Body

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"
}

Modified at 2024-05-07 06:32:00

Detach a PaymentMethod from a Customer

Retrieve a refund