---
title: "Get a payment"
method: GET
path: "/payments/{payment_id}"
tags: ["Payments"]
---

# Get a payment

`GET /payments/{payment_id}`

## Request

- Base URL: `https://api.aisle.wedding/v1`
- URL: `https://api.aisle.wedding/v1/payments/{payment_id}`
- Auth: HTTP bearer

Requires an API key with the payments scope. A payment outside the key wedding is not found.

## Path parameters

- `payment_id` string, required

## Response `200`

Success.

- object
  - `data` Payment, required
    - `id` string, required
    - `guest_id` string, nullable, required
    - `type` string, required
    - `amount` string, required: A decimal currency amount serialized as a string.
    - `platform_fee` string, nullable, required: A decimal currency amount serialized as a string.
    - `fee_paid_by_guest` boolean, required
    - `currency` string, required
    - `status` 'pending' | 'completed' | 'failed' | 'refunded', required
    - `description` string, nullable, required
    - `instalment` string, nullable, required
    - `charge_total` string, nullable, required: A decimal currency amount serialized as a string.
    - `registry_contribution_id` string, nullable, required
    - `accommodation_id` string, nullable, required
    - `event_id` string, nullable, required
    - `refunded_at` string, date-time, nullable, required
    - `refund_reason` string, nullable, required
    - `created_at` string, date-time, required: An RFC 3339 UTC timestamp with milliseconds.
    - `updated_at` string, date-time, required: An RFC 3339 UTC timestamp with milliseconds.

## Other responses

- `400`: The request itself could not be read, such as a body that is not a JSON object. A field we refuse is validation_failed instead.
- `401`: The API key is missing, malformed, or no longer valid.
- `402`: The operation requires an active Aisle membership for this wedding.
- `403`: The key is valid but not permitted to do this.
- `404`: No such resource inside the key's wedding.
- `405`: That HTTP method is not supported here. See the Allow header.
- `409`: The request collided with the current state of the resource.
- `415`: A request body must be sent as application/json.
- `422`: The request was well-formed but a field was not acceptable. Every field at fault is named in error.details.
- `429`: Too many requests. Retry after the time given in Retry-After.
- `500`: Something went wrong on our side.

---

[API](https://skmtc.dev/aisle/apis/aisle-api.md) · [All operations](https://skmtc.dev/aisle/apis/aisle-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aisle/apis/aisle-api/revisions/689a2f2420cc?raw)