---
title: "POST /payments/getPaymentInstrument"
method: POST
path: "/payments/getPaymentInstrument"
---

# POST /payments/getPaymentInstrument

`POST /payments/getPaymentInstrument`

Get a payment instrument by ID.

## Headers

- `X-Amzn-Bedrock-AgentCore-Payments-User-Id` string
- `X-Amzn-Bedrock-AgentCore-Payments-Agent-Name` string — The agent name associated with the payment request.

## Request body

- object
  - `paymentManagerArn` string, required — The ARN of the payment manager that owns this payment instrument.
  - `paymentConnectorId` string — The ID of the payment connector.
  - `paymentInstrumentId` string, required — The ID of the payment instrument to retrieve.

## Response `200`

Success

- GetPaymentInstrumentResponse — Response structure for getting a payment instrument.
  - `paymentInstrument` object, required — The payment instrument details.
    - `paymentInstrumentId` string, required — The unique identifier for this payment instrument.
    - `paymentManagerArn` string, required — The ARN of the payment manager that owns this payment instrument.
    - `paymentConnectorId` string, required — The ID of the payment connector associated with this instrument.
    - `userId` string, required — The user ID associated with this payment instrument.
    - `paymentInstrumentType` 'EMBEDDED_CRYPTO_WALLET', required — The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET).
    - `paymentInstrumentDetails` object, required — The details specific to the payment instrument type.
      - `embeddedCryptoWallet` object — Embedded crypto wallet managed directly by end user.
        - `network` 'ETHEREUM' | 'SOLANA', required — The blockchain network for this embedded crypto wallet. Supported networks: ETHEREUM, SOLANA.
        - `linkedAccounts` LinkedAccount[], required — List of linked accounts linked to this wallet. Each represents a way the end user can authenticate to this wallet.
          - `email` object — Email-based linked account.
            - `emailAddress` string, password, required — The email address used for the linked account. Must be a valid email format.
          - `sms` object — SMS-based linked account using phone number.
            - `phoneNumber` string, password, required — The phone number in E.164 format (e.g., +1234567890).
          - `developerJwt` object — Developer JWT linked account with key ID and subject.
            - `kid` string, required — The key ID (kid) from the JWT header. Identifies which key was used to sign the JWT.
            - `sub` string, required — The subject (sub) claim from the JWT payload. Identifies the principal that is the subject of the JWT.
          - `oAuth2` object — OAuth2 provider linked account (Google, Apple, X, Telegram, GitHub).
            - `google` object — Google OAuth2 authentication.
              - …
            - `apple` object — Apple OAuth2 authentication.
              - …
            - `x` object — X (formerly Twitter) OAuth2 authentication.
              - …
            - `telegram` object — Telegram OAuth2 authentication.
              - …
            - `github` object — GitHub OAuth2 authentication.
              - …
        - `walletAddress` string — The wallet address on the specified blockchain network.
        - `redirectUrl` string — URL for the end user to complete a provider-specific action such as wallet linking or onboarding.
    - `createdAt` string, date-time, required — The timestamp when this payment instrument was created.
    - `status` 'INITIATED' | 'ACTIVE' | 'FAILED' | 'DELETED', required — The current status of this payment instrument.
    - `updatedAt` string, date-time, required — The timestamp when this payment instrument was last updated.

## Other responses

- `480` — AccessDeniedException
- `481` — ValidationException
- `482` — ResourceNotFoundException
- `483` — ThrottlingException
- `484` — InternalServerException

---

[API](https://skmtc.net/aws/apis/bedrock-agentcore.md) · [All operations](https://skmtc.net/aws/apis/bedrock-agentcore/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/bedrock-agentcore/versions/79623b33d495/schema)