---
title: "Creating a Payment Request."
method: POST
path: "/v1/payments"
tags: ["PaymentRequests"]
---

# Creating a Payment Request.

`POST /v1/payments`

## Request body

- CreatePaymentRequest
  - `amount` PaymentRequestAmount, required
    - `currency` string, required
    - `value` number, double, required
  - `creditor` PaymentCreditor, required
    - `account` PaymentAccount, required
      - `accountNumber` string, required
      - `accountType` 'IBAN' | 'BBAN' | 'BG' | 'PG', required
      - `bic` string, nullable
      - `currencyCode` string, nullable
    - `message` string, nullable
    - `name` string, required
  - `debtor` PaymentDebtor
    - `account` PaymentAccount, required
      - `accountNumber` string, required
      - `accountType` 'IBAN' | 'BBAN' | 'BG' | 'PG', required
      - `bic` string, nullable
      - `currencyCode` string, nullable
    - `message` string, nullable
    - `name` string, nullable
  - `executionDate` integer, nullable
  - `remittanceInformation` PaymentRequestRemittanceInformation, required
    - `value` string, required
    - `type` 'UNSTRUCTURED' | 'OCR', required
  - `region` string, required
  - `paymentProductId` string, required
  - `paymentTemplateId` string, nullable

## Response `201`

The request has been fulfilled and a payment request is created.

- PaymentRequestModel
  - `id` string, uuid, required
  - `clientId` string, nullable
  - `ClientAccess` string, nullable
  - `status` string, nullable
  - `amount` PaymentRequestAmount, required
    - `currency` string, required
    - `value` number, double, required
  - `creditor` PaymentCreditor, required
    - `account` PaymentAccount, required
      - `accountNumber` string, required
      - `accountType` 'IBAN' | 'BBAN' | 'BG' | 'PG', required
      - `bic` string, nullable
      - `currencyCode` string, nullable
    - `message` string, nullable
    - `name` string, required
  - `debtor` PaymentDebtor
    - `account` PaymentAccount, required
      - `accountNumber` string, required
      - `accountType` 'IBAN' | 'BBAN' | 'BG' | 'PG', required
      - `bic` string, nullable
      - `currencyCode` string, nullable
    - `message` string, nullable
    - `name` string, nullable
  - `executionDate` integer, nullable
  - `remittanceInformation` PaymentRequestRemittanceInformation, required
    - `value` string, required
    - `type` 'UNSTRUCTURED' | 'OCR', required
  - `region` string, required
  - `paymentProductId` string, required
  - `paymentTemplateId` string, nullable

## Other responses

- `400` — Error caused by invalid or missing data.
- `401` — Authentication failed due to missing or invalid credentials.
- `403` — Error caused by user not permitted access to the resource.
- `404` — Endpoint does not exist or URL is not constructed correctly.
- `500` — Error caused by remote technical issues, this status code is used for unforeseen technical issues.
- `503` — Returned when service is unavailable due to scheduled reasons, such as maintenance.

---

[API](https://skmtc.net/finshark/apis/finshark-api.md) · [All operations](https://skmtc.net/finshark/apis/finshark-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/finshark/finshark-api/versions/7fc3b4f800ae/schema)