---
title: "Create payment request"
method: POST
path: "/payments/v1/payment-requests"
tags: ["Payment requests"]
---

# Create payment request

`POST /payments/v1/payment-requests`

Create a new payment request. Once created, call the [Transfer funds](https://developers.pismo.io/pismo-docs/reference/post-payments-v1-payments) endpoint to execute the payment.

For additional information, see the [Payment requests](https://developers.pismo.io/pismo-docs/docs/payment-requests) guide.

## Headers

- `x-tenant` string, required
- `x-account-id` string
- `x-cid` string

## Request body

- PaymentRequestModel — Payload object for Create payment request (`v1/payment-requests`).
  - `to` PaymentMethodAccount, required — Payment method for Pismo account transfers.
    - `account` object
      - `id` integer, required — Pismo platform account ID.
    - `amount` number, float — Credit or debit amount.
    - `processing_code` string — Optional for use with private acceptance/acquiring merchant networks. Can be used to define a different settlement condition (MDR, days to settle, and so on). For details, see acquiring/marketplace documentation.
    - `currency` string — ISO-4217 currency code.
    - `beneficiary_id` string — Unique string identifier for the beneficiary associated with the account.
  - `from` PaymentMethodAccount — Payment method for Pismo account transfers.
    - `account` object
      - `id` integer, required — Pismo platform account ID.
    - `amount` number, float — Credit or debit amount.
    - `processing_code` string — Optional for use with private acceptance/acquiring merchant networks. Can be used to define a different settlement condition (MDR, days to settle, and so on). For details, see acquiring/marketplace documentation.
    - `currency` string — ISO-4217 currency code.
    - `beneficiary_id` string — Unique string identifier for the beneficiary associated with the account.
  - `amount` number, float, required — Payment request amount.
  - `processing_code` string — Payment request processing code.
  - `expiration` string, date-time — Payment request expiration date in UTC-0 (RFC3339) format.
  - `tracking_id` string — Optional unique ID correlating the payment request's associated credit and debit authorizations.
  - `metadata` string — Any data object with key/value pairs. No limit on length. **Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).
  - `location` Location — Request latitude and longitude object.
    - `lat` number, float — Request latitude.
    - `lng` number, float — Request longitude.

## Response `200`

OK

- PaymentRequestResponse — Response object from Create payment request (`v1/payment-requests`).
  - `type` string — Payment request format type.
  - `code` string — Payment request ID code. Token field for Transfer funds (`v1/payments`)

## Other responses

- `400` — Bad request
- `500` — Internal server error

---

[API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/revisions/935b62e16de4/schema)