---
title: "Create Payment Option"
method: POST
path: "/v2/identities/{identifier}/payment/options"
tags: ["Payment"]
---

# Create Payment Option

`POST /v2/identities/{identifier}/payment/options`

## Request

- The document declares no server URL.
- Auth: HTTP basic

Create a payment option for the provided identity.

## Path parameters

- `identifier` string, required

## Request body

- PaymentOptionRequest
  - `name` string, required
  - `description` string, required
  - `paymentOptions` PaymentOptionConfigItem[], required
    - `paymentOptionID` integer, required
    - `amount` string, required
    - `recipient` string, required
    - `signingKeyID` string, required: base64 encoded keyID
    - `expiration` string, date-time: Expiration date for the payment option, if not set the 1 hour from the creation date will be used

## Response `201`

Payment Option Created

- UUIDResponse
  - `id` string, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `409`: Conflict
- `500`: Internal Server error

## Changes

- **2025-01-03** `89950aec558b`: 1 info
  - added the non-success response with the status `409`
- **2025-01-02** `f5336b4fb022`: 1 breaking, 1 warning
  - added the new required request property `paymentOptions`
  - removed the request property `config`
- **2024-12-27** `2981b0b5cd88`: 1 info
  - endpoint added
- **2024-12-26** `7911e50304ae`: 1 breaking
  - api path removed without deprecation
- **2024-12-24** `d705ece785fa`: 1 breaking, 1 warning
  - added the new required request property `paymentOptions`
  - removed the request property `config`

[Operation history](https://skmtc.dev/0xpolygonid/apis/privado-id-issuer/changes/v2/identities/:identifier/payment/options/post.md)

---

[API](https://skmtc.dev/0xpolygonid/apis/privado-id-issuer.md) - [All operations](https://skmtc.dev/0xpolygonid/apis/privado-id-issuer/llms.txt) - [OpenAPI document](https://skmtc.dev/0xpolygonid/apis/privado-id-issuer/revisions/8ea65174fe46?raw)
