API
Sign in

Payments

Create, retrieve, capture, cancel, and list payments.

View as Markdown

A payment moves money from a customer to your account. For most integrations you create a payment with an amount and a payment method and VINR authorizes and captures it in one step. If you need to separate authorization from capture, route across acquirers, or handle 3DS yourself, see Advanced below each section.

Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.

The payment objectAsk

idstring

Unique identifier for the payment, e.g. pay_3Nx8a2Lk.

amountinteger

Amount intended to be collected, in the smallest currency unit (e.g. cents).

currencystring

Three-letter ISO currency code, e.g. EUR.

statusenum

One of succeeded, requires_action, processing, failed, or canceled.

customerobjectExpandable

The customer this payment belongs to, if any. Expand to retrieve the full object.

latest_chargeobjectExpandable

The most recent charge created by this payment, e.g. ch_1Pf2.

Create a paymentAsk

Pass an amount, currency, and payment method. VINR authorizes and captures in one step, returning a succeeded payment.

Retrieve a paymentAsk

Fetch a payment by its ID. Returns the full payment object including the latest charge.

Capture a paymentAsk

A payment created with capture_method: 'manual' sits in requires_capture until you capture it. Capturing transitions the status to succeeded and settles the funds.

Cancel a paymentAsk

Cancel a payment that has not yet been captured. The status transitions to canceled and any authorization hold on the customer's payment method is released.

List paymentsAsk

Returns a paginated list of payments, newest first. Use the customer filter to scope results to a single customer.

ParameterTypeDescription
limitintegerNumber of results to return. Default 10, max 100.
customerstringFilter payments by customer ID.

Adjust an authorizationAsk

Increase or decrease the authorized amount before capture. Useful for hotel incidentals, tips added after the sale, or removing a cancelled line item. The issuer re-evaluates the adjustment and may decline an increase.

Reverse a paymentAsk

A reversal cancels an authorized-but-not-yet-captured payment and immediately releases the hold. Equivalent to cancel for most integrations; use reverse for acquirers that distinguish between a void (same-day same-acquirer release) and a generic cancel.

payment.succeeded, payment.requires_action, payment.captured, payment.failed, payment.canceled, payment.adjusted, and payment.reversed. See Events.

Was this page helpful?