Create a refund

Create a refund or partial refund for an approved intent

POST /refund

Create a refund

cURL

curl --request POST \
  --url https://api.pushcash.com/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent_id": "intent_sandbox_dMggQ93ZYH6DH9LBhVeijE",
  "amount": 1450
}
'

200

{
  "id": "refund_28CJjV7P4Go5PNJvfzghiD",
  "intent_id": "intent_sandbox_dMggQ93ZYH6DH9LBhVeijE",
  "amount": 1450,
  "currency": "USD",
  "status": "approved",
  "created_at": "2023-05-24T20:36:50.694Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

intent_id · string · required

The ID of the intent to refund

Example:

"intent_sandbox_dMggQ93ZYH6DH9LBhVeijE"

amount · integer

Amount to refund in the smallest unit of the specified currency. If omitted, the full intent amount is refunded.

Example:

1450

Response

200

application/json

Refund approved

A refund issued against an approved intent

id · string · required

The unique identifier assigned by Push

intent_id · string · required

The intent which corresponds to the refund

amount · integer · required

Amount of the refund in the smallest unit of specified currency (ie if currency is USD, the unit would be cents)

currency · enum<string> · required

Currency associated with the amount

Available options: USD

status · enum<string> · required

The status of the refund

Available options: approved, declined

created_at · string<date-time> · required

When the refund was created (ISO 8601 date string)