Retrieve a refund - WooshPay OpenAPI

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

Path Params

refund_id

string

required

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://apitest.wooshpay.com/v1/refunds/' \
--header 'Accept;' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic Og==' \
--data-raw ''

Responses

🟢200OK

application/json

Body

id

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": "re_3KQu4U2eZvKYlo2C02Ndp8xy",
    "object": "refund",
    "amount": 100,
    "created": 1644328172,
    "currency": "usd",
    "metadata": {},
    "payment_intent": "pi_3KQu4U2eZvKYlo2C0avUn9aJ",
    "reason": null,
    "receipt_number": null,
    "status": "succeeded"
}