Get payment request

GET

/v1/payment_requests/{request_id}

Get a payment request by ID.

Parameters

Path Parameters

request_id

required

Request Id

string format: uuid

Responses

200

Successful Response

PaymentRequestResponse

Schema for payment request response.

object

id

required

Id

string format: uuid

organization_id

required

Organization Id

string format: uuid

customer_id

required

Customer Id

string format: uuid

dunning_campaign_id

Any of:

string

string format: uuid

null

null

amount_cents

required

Amount Cents

string

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

amount_currency

required

Amount Currency

string

payment_status

required

Payment Status

string

payment_attempts

required

Payment Attempts

integer

ready_for_payment_processing

required

Ready For Payment Processing

boolean

invoices

Invoices

Array<object>

PaymentRequestInvoiceResponse

Schema for payment request invoice join response.

object

id

required

Id

string format: uuid

payment_request_id

required

Payment Request Id

string format: uuid

invoice_id

required

Invoice Id

string format: uuid

created_at

required

Created At

string format: date-time

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized

404

Payment request 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