# Create Payment Request

## Create a Payment Request

<mark style="color:green;">`POST`</mark> `https://api.finove.com.br/api/v1/merchant/payment-requests`

Registers a payment info with our system and returns a URL that can be sent to the client to complete the payment or used within an iframe.

#### Headers

| Name          | Type   | Description                                                                           |
| ------------- | ------ | ------------------------------------------------------------------------------------- |
| Authorization | string | Access token received from Authentication API. ex. "Bearer your\_access\_token\_here" |

#### Request Body

| Name                                                  | Type   | Description                                                                                                                                                                   |
| ----------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| installmentsCountMin                                  | number | Minimum number of installments that customer can select.                                                                                                                      |
| installmentsCountMax                                  | number | Maximum number of installments that customer can select.                                                                                                                      |
| customerTaxId                                         | string | Cnpj of customer (ex. "27938392000190")                                                                                                                                       |
| currency                                              | string | Code of currency for amount (ex. "BRL")                                                                                                                                       |
| amount                                                | string | Amount of the purchase in cents (R$ 1.000,99 should be submitted as 100099)                                                                                                   |
| orderId                                               | string | ID of order in your system (can be any string)                                                                                                                                |
| orderDescription                                      | string | Description of order as a string. If it's a list of items, you can separate the items with semi-colons (ex. "Product A; Product B; Product C;")                               |
| meta                                                  | object | Any additional data you want stored with the payment. May contain any key/value pairs. Should be an object with only one level of nesting. (ex. { internal\_id: 12345, ... }) |
| merchantSubsidyType<mark style="color:red;">\*</mark> | String | <p>Payment request subsidy type:<br>none, rate, amount or free</p>                                                                                                            |
| merchantSubsidyRate                                   | String | required if merchantSubsidyType is rate                                                                                                                                       |
| merchantSubsidyAmount                                 | String | required if merchantSubsidyType is amount                                                                                                                                     |
|                                                       | String |                                                                                                                                                                               |

{% tabs %}
{% tab title="200 " %}

```
{
    "id": "7fa09437-64e8-4c38-9a72-2f319c8a1c72",
    "meta": {},
    "amount": 100000,
    "currency": "BRL",
    "orderId": "91",
    "orderDescription": "5",
    "merchantSubsidyRate": null,
    "merchantSubsidyAmount": null,
    "installmentsCountMin": null,
    "installmentsCountMax": null,
    "customerTaxId": "28094307000118",
    "createdAt": "2022-07-06T20:07:03.124Z",
    "updatedAt": "2022-07-06T20:07:03.124Z",
    "expiresOn": "2022-07-08",
    "firstInstallmentDate": null,
    "code": "7fa09437-64e8-4c38-9a72-2f319c8a1c72",
    "url": "http://finavo.localhost:3001/financing/7fa09437-64e8-4c38-9a72-2f319c8a1c72",
    "existingBorrower": true,
    "merchantSubsidyType": "none",
    "financingStatus": "open"
}
```

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
**Note:** Payment Requests have an expiration specified by the `expiresOn` attribute. Currently, the **expiration is 7 days after the payment request is created**. A customer must complete the payment request (by creating a payment to the merchant) on or before that date. If the payment request expires, a new payment request must be created. In some cases, our support team may be able to extend the expiration date manually, but we suggest factoring the expiration into your integration.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.finove.com.br/embed-in-website/payment-request/create-payment-request.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.