Read the full refund for a payment (owner only)

GET

/dashboard/v1/merchants/{merchantId}/{mode}/payments/{id}/refunds

curl --request GET \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/payments/example/refunds \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

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

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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

401

Sign-in required

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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

403

Forbidden

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

409

Idempotency conflict or invalid state

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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