Record manual payment

POST

/v1/payments/record

Record a manual/offline payment (e.g. check, wire transfer, cash).

Creates a payment record with status ‘succeeded’, records a settlement, and auto-marks the invoice as paid if fully settled.

Request Body ^required

ManualPaymentCreate

Schema for recording a manual/offline payment.

object

invoice_id

required

Invoice Id

Invoice this payment is for

string format: uuid

amount

required

Any of:

number

number

> 0

string

string

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

currency

Currency

Payment currency (3-letter ISO code)

string

default: USD

reference

Any of:

string

string

null

null

notes

Any of:

string

string

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 finalized invoices can have payments recorded

401

Unauthorized – invalid or missing API key

404

Invoice 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