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

# Create payment request

`POST /payments/v1/payment-requests`

## Request

- Base URL: `https://sandbox.pismolabs.io`
- URL: `https://sandbox.pismolabs.io/payments/v1/payment-requests`
- Auth: HTTP bearer

Create a new payment request. Once created, call the [Transfer funds](ref:post-payments-v1-payments) endpoint to execute the payment.

For additional information, see the [Payment requests](doc: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 alphabetic or numeric (3 characters) operation currency code. For example, either BRL or 986 for Brazilian real.
    - `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 alphabetic or numeric (3 characters) operation currency code. For example, either BRL or 986 for Brazilian real.
    - `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` Metadata: This optional user-defined key-value object field can be used with external operations to provide additional context or supplementary custom information for the operation. The Pismo platform does not perform any validation or processing on this field but passes this object to the acquirer in transactions involving calls to the acquirer and sends it in the events related to the stream of data produced at the end of the request. **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](ref: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.dev/pismo/apis/core-platform-payment-methods.md) - [All operations](https://skmtc.dev/pismo/apis/core-platform-payment-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/core-platform-payment-methods/revisions/ab9e879a54e0?raw)