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

# Create Payment Request

`POST /v2/identities/{identifier}/payment-request`

## Request

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

Create a payment request for the provided identity.

## Path parameters

- `identifier` string, required

## Request body

- CreatePaymentRequest
  - `optionID` string, required
  - `schemaID` string, required
  - `description` string, required
  - `userDID` string, required

## Response `201`

Payment Request Created

- CreatePaymentRequestResponse
  - `id` string, uuid, required
  - `issuerDID` string, required
  - `userDID` string, required
  - `paymentOptionID` string, uuid, required
  - `payments` PaymentRequestInfo[], required
  - `createdAt` string, date-time, required
  - `modifiedAt` string, date-time, required
  - `status` 'not-verified' | 'success' | 'failed' | 'pending' | 'canceled', required
  - `paidNonce` string
  - `schemaID` string, uuid

## Other responses

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

## Changes

- **2025-03-10** `cc69e96e4c66`: 1 info
  - added the optional property `schemaID` to the response with the `201` status
- **2025-01-27** `c208500aae05`: 3 info
  - added the optional property `paidNonce` to the response with the `201` status
  - added the required property `modifiedAt` to the response with the `201` status
  - added the required property `status` to the response with the `201` status
- **2024-12-27** `2981b0b5cd88`: 1 info
  - endpoint added
- **2024-12-26** `7911e50304ae`: 1 breaking
  - api path removed without deprecation
- **2024-12-23** `3b774233550c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/0xpolygonid/apis/privado-id-issuer/changes/v2/identities/:identifier/payment-request/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)