Skip to main content
GET
Get a contactless payment

Path Parameters

contactlessPaymentId
string
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Response

Ok. The operation succeeded.

A pending or collected in-person payment for an appointment.

id
string
required

The unique identifier for this contactless payment.

appointment
object
required

The appointment this payment collects.

amount
string<decimal>
required

The amount to collect.

Pattern: ^-?(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

state
enum<string>
required

The payment state.

Available options:
created,
processing,
authorized,
captured,
failed,
canceled
clientSecret
string
required

The client secret associated with the payment processor integration.

createdAt
string<date-time>
required

The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

updatedAt
string<date-time>
required

The date-time when this resource was updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

externalPaymentReference
object

The payment processor's reference for this payment.

card
object

The card-present payment method summary.

authorizedAt
string<date-time>

The date-time when the payment was authorized.

capturedAt
string<date-time>

The date-time when the payment was captured.

expiresAt
string<date-time>

The expiration date-time for this payment session.