---
title: "Retrieves a PaymentIntent resource."
method: GET
path: "/payment_intents/{id}"
tags: ["PaymentIntent"]
---

# Retrieves a PaymentIntent resource.

`GET /payment_intents/{id}`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/payment_intents/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/payment_intents/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a PaymentIntent resource.

## Path parameters

- `id` string, required

## Response `200`

PaymentIntent resource

- PaymentIntent: Payment intent captures the process of collecting a payment from customers
  - `id` string
  - `integration` string: The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string: Unique identifier for each payment intent
  - `amount` integer: The amount intended to collected from the payment intent
  - `amountCapturable` integer, nullable: The amount that can be captured from the payment intent
  - `amountReceived` integer, nullable: Amount that was collected by the payment intent
  - `clientSecret` string: The client secret of the payment intent
  - `confirmationMethod` string, nullable: The method of confirmation used.
  - `created` string, date-time, nullable: The date and time the payment intent was created
  - `currency` string: The currency used in the payment intent
  - `customerId` string, nullable: The ID of the customer the payment intent belongs to
  - `description` string, nullable: A description about the payment intent
  - `invoiceId` string, nullable: The ID of the invoice that created this payment intent
  - `paymentMethodId` string, nullable: The ID of the payment method used.
  - `email` string, nullable: The email address that the receipt for the resulting payment will be sent to
  - `shippingName` string, nullable: Recipient name
  - `shippingPhone` string, nullable: Recipient phone number
  - `shippingAddress` string, nullable: Shipping address for the payment intent
  - `status` string, nullable: Status of the payment intent e.g. "requires_payment_method" e.g. "requires_confirmation" e.g. "succeeded"

## Other responses

- `404`: Resource not found

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)