Refund payment

POST

/v1/payments/{payment_id}/refund

Refund a succeeded payment. Optionally specify an amount for partial refund.

Parameters

Path Parameters

payment_id

required

Payment Id

string format: uuid

Request Body

Any of:

RefundRequest

RefundRequest

Schema for refund request with optional partial amount.

object

amount

Any of:

number

number

> 0

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

null

null

Responses

200

Successful Response

PaymentResponse

Schema for payment response.

object

id

required

Id

string format: uuid

invoice_id

required

Invoice Id

string format: uuid

customer_id

required

Customer Id

string format: uuid

amount_cents

required

Amount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

currency

required

Currency

string

status

required

Status

string

provider

required

Provider

string

provider_payment_id

Any of:

string

string

null

null

provider_checkout_id

Any of:

string

string

null

null

provider_checkout_url

Any of:

string

string

null

null

failure_reason

Any of:

string

string

null

null

payment_metadata

Any of:

object

object

key

additional properties

any

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

completed_at

Any of:

string

string format: date-time

null

null

400

Only succeeded payments can be refunded

401

Unauthorized – invalid or missing API key

404

Payment not found

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object