Refund a succeeded Wave payment in full

POST

/v1/payments/{id}/refunds

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

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Header Parameters

idempotency-key

required

Required retry-safe key; reuse it only for the same operation and request body

string

>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Responses

201

Full refund

Media typeapplication/json

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

Example

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

422

Insufficient funds or unsupported provider

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

503

Provider or ledger outcome requires retry/review

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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