Get payment attempt by ID

Request

Retrieve a single payment attempt for the location.

Security

PartnerApiKey and PartnerOAuth

Path

paymentAttemptIdinteger, (int64)required

Payment attempt ID

Example:42

accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/payment-attempt/42' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Payment attempt found

Bodyapplication/json

amountobject(Money)

Monetary amount

createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"

externalIdstring

External payment-processor reference. For MX Merchant (the only supported V1 provider) this is the MXM transaction / QuickPay reference — the key to map this attempt back to the payment in MX Merchant.

Example:"pi_abc123"

idinteger, (int64)

Payment attempt ID

Example:42

invoiceIdinteger, (int64)

Invoice ID this attempt is associated with, if any. May be null for V1 recurring/subscription attempts that are not tied to a single invoice — in that case it is backfilled from the recurring payment's originating invoice when one exists, and subscriptionId provides the correlation key otherwise.

Example:1001

locationIdinteger, (int64)

Location ID for invoice lookups. Resolved from the associated invoice when present, otherwise from the recurring payment (subscription) the attempt belongs to. May be null only for legacy V1 attempts with neither association.

Example:55

patientIdinteger, (int64)

Patient ID. May be null for legacy attempts where a patient association is not resolvable.

Example:3003

paymentMethodIdinteger, (int64)

Payment method ID if present

Example:7

purchaseOrderIdinteger, (int64)

Purchase order ID from the invoice, if any

Example:2002

statusstring

Attempt status

Enum:"PENDING""SUCCEEDED""FAILED""CANCELED"

Example:"PENDING"

subscriptionIdinteger, (int64)

Recurring payment (subscription) ID this attempt belongs to, if any. For V2 this is the invoice's subscription ID; for V1 this is the recurring payment ID. Populated when the attempt is part of a recurring schedule — the correlation key for attempts that have no directly associated invoice.

Example:555

Response

{
  "amount": {
    "amount": 50,
    "currency": "USD"
  },
  "createdAt": "2025-01-15T14:00:00Z",
  "externalId": "pi_abc123",
  "id": 42,
  "invoiceId": 1001,
  "locationId": 55,
  "patientId": 3003,
  "paymentMethodId": 7,
  "purchaseOrderId": 2002,
  "status": "PENDING",
  "subscriptionId": 555
}