Read the full refund for a payment, if one exists

GET

/v1/payments/{id}/refunds

curl --request GET \
  --url http://localhost:4000/v1/payments/example/refunds \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Responses

200

Zero or one refund

Media typeapplication/json

object

object

required

string

Allowed values: list

data

required

Array<object>

object

id

required

string

object

required

string

Allowed values: refund

payment_id

required

string

amount

required

integer

currency

required

string

Allowed values: XOF

status

required

string

Allowed values: pending succeeded needs_review

fee_refunded

required

integer

created_at

required

string

has_more

required

boolean

Example

{
  "object": "list",
  "data": [
    {
      "object": "refund",
      "currency": "XOF",
      "status": "pending"
    }
  ]
}

400

Validation error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Authentication error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Rate limited; see Retry-After response header

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}