List payments

GET

/v1/payments/

List payments with optional filters.

Parameters

Query Parameters

skip

Skip

integer

0

limit

Limit

integer

default: 100 >= 1 <= 1000

order_by

Any of:

string

string

null

null

invoice_id

Any of:

string

string format: uuid

null

null

customer_id

Any of:

string

string format: uuid

null

null

status

Any of:

PaymentStatus

PaymentStatus

Payment status enum.

string

Allowed values: pending processing succeeded failed refunded canceled

null

null

provider

Any of:

PaymentProvider

PaymentProvider

Supported payment providers.

string

Allowed values: stripe manual ucp gocardless adyen

null

null

Responses

200

Successful Response

Response List Payments V1 Payments Get

Array<object>

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

401

Unauthorized – invalid or missing API key

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