Skip to content
Developers

Refund a committed payment intent, in whole or in part.

POST
/payments/card/{id}/refund
curl --request POST \
  --url https://api.paygasus.com/payments/card/pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV/refund \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amount": 1000 }'

Refunds are aggregate-only: there is no per-refund object and no refund-enumeration endpoint. Only amount_refunded on the intent reflects the running total refunded; issue multiple calls for multiple partial refunds up to the captured amount.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
Example
pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV

Payment intent ID

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
amount
required

Amount to refund, in the currency’s minor units. Must not exceed the remaining refundable amount (amount_captured − amount_refunded).

integer format: int64
Example
1000

Responses

Section titled “Responses”

200

Section titled “200”

Refunded. The returned intent’s amount_refunded reflects the new aggregate total

Media typeapplication/json
object
amount
required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64
amount_captured
required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64
amount_refunded
required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64
capture_method
required
string
Allowed values: automatic manual
created
required
integer format: int64
currency
required

Currently supported currencies by Paygasus Pay

string
Allowed values: USD
description
string | null
id
required
string
livemode
required
boolean
metadata
required
object
key
additional properties
string
payment_method
required
object
brand
required
string
Allowed values: AMEX VISA MASTERCARD DISCOVER
last4
required
string
statement_descriptor
string | null
status
required
One of:
object
status
required
string
Allowed values: created
updated
required
integer format: int64
Example
{
  "amount": 1000,
  "amount_captured": 1000,
  "amount_refunded": 1000,
  "capture_method": "automatic",
  "currency": "USD",
  "id": "pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "payment_method": {
    "brand": "AMEX"
  },
  "status": {
    "status": "created"
  }
}

404

Section titled “404”

No such payment intent

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "param": "example",
    "type": "example"
  }
}

409

Section titled “409”

Intent is not in a refundable state, is already being processed, or the amount exceeds the refundable remaining

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "param": "example",
    "type": "example"
  }
}

502

Section titled “502”

Processor transport failure; the operation is retryable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "param": "example",
    "type": "example"
  }
}