# Payment Requests

A Payment Request generates a url that the customer can use to complete the payment (financing). 

Once the customer completes the payment process, the Payment Request's `status` is marked as "completed" and a [Payment object](https://developers.finove.com.br/payments#payment-object) is created. From that point on, all data related to the payment will be found in the Payment object. The Payment object will include the `orderId`, `orderDescription`, and `meta` specified in the Payment Request. The updated Payment Request object will contain the id of the created payment under `paymentId`.

## Endpoints

[Create Payment Request](https://developers.finove.com.br/embed-in-website/payment-request/create-payment-request) - Create a payment request

[List Payments Requests](https://developers.finove.com.br/embed-in-website/payment-request/list-payment-requests) - Fetch a list of all payment requests

[Get Payment Requests](https://developers.finove.com.br/embed-in-website/payment-request/get-payment-request) - Fetch a single payment request

## Payment Request Object

| id                    | string | Id for the payment request                                                                                                           |
| --------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| status                | string | Status of the payment request. (pending \| completed \| expired)                                                                     |
| amount                | number | Payment request amount in cents (R$ 1.000,99 is represented as 100099)                                                               |
| currency              | string | Currency of the amount                                                                                                               |
| orderId               | string | An ID unique to your system to identify the order                                                                                    |
| orderDescription      | string | Description of the order                                                                                                             |
| meta                  | object | A json object you can use to store custom data attributes for use in integrations. Please send a single level object: {"foo": "bar"} |
| customerTaxId         | string | Tax ID (CNPJ) of customer (no formatting)                                                                                            |
| expiresOn             | date   | date that payment request expires                                                                                                    |
| merchantAccountId     | string | ID of the merchant account that created the payment request                                                                          |
| merchantSubsidyType   | enum   | Type of merchant subsidy (none \| rate \| amount)                                                                                    |
| merchantSubsidyRate   | number | Percent of interest merchant will cover on behalf of customer (optional setting)                                                     |
| merchantSubsidyAmount | number | Value of interest merchant will cover on behalf of customer (optional setting)                                                       |
| installmentsCountMin  | number | Minimum number of installments a customer can select (optional setting)                                                              |
| installmentsCountMax  | number | Maximum number of installments a customer can select (optional setting)                                                              |
| firstInstallmentDate  | date   | Date of first installment (optional setting)                                                                                         |
| merchantRecourseRate  | number | Recourse rate covered by merchant (if applies to merchant account)                                                                   |
| code                  | string | Alias of ID                                                                                                                          |
| url                   | string | Url that can be shared with customer to complete payment request                                                                     |