# API PayMee 1.1

## Docs

- [Architecture](https://developer.paymee.com.br/api-reference/architecture.md): Overview of the PayMee API integration model, endpoints, and HTTP methods used.
- [Cancel a transaction](https://developer.paymee.com.br/api-reference/cancel-a-transaction.md): Allows the merchant to cancel a **PENDING** sale. Any other situation will return an error.
- [Cancel authorization](https://developer.paymee.com.br/api-reference/cancel-authorization.md): Cancels a recurring payment authorization.
- [Cancel scheduled payment](https://developer.paymee.com.br/api-reference/cancel-scheduled-payment.md): Cancels a scheduled payment that has not yet been processed.
- [Create a loan](https://developer.paymee.com.br/api-reference/checkouts/create.md): Creates a loan based on a previously approved proposal
- [Redirect checkout](https://developer.paymee.com.br/api-reference/checkouts/redirect-checkout.md): To generate a transaction through PayMee, it is necessary to send a request using the POST method to the checkout resource, as shown. This example covers the minimum of submitted fields required for authorization.
- [Semi-transparent wire-transfer, pix and credit card and openbanking checkout](https://developer.paymee.com.br/api-reference/checkouts/semi-transparent-wire-transfer-pix-and-credit-card-and-openbanking-checkout.md): To generate a transaction throught PayMee, it is necessary to send a request using the POST method to the **checkout** resource, as shown. This example covers the minimum of fields required to be submitted for authorization.
- [Simulation](https://developer.paymee.com.br/api-reference/checkouts/simulation.md): Create a loan simulation based on customer information and requested amount
- [Create Pix Automatic Recurrence](https://developer.paymee.com.br/api-reference/create-pix-automatic-checkout.md): Creates a Pix Automatic recurrence journey. Use the `immediatePayment` flag inside the `recurrence` object to control the flow: `false` for Journey 2 (authorization only), or `true` for Journey 3 (authorization with an immediate payment).
- [Create a recurrence plan](https://developer.paymee.com.br/api-reference/create-plan.md): Creates a new recurrence plan for Pix Automatic.
- [Get authorization by recurrence ID](https://developer.paymee.com.br/api-reference/get-authorization-by-id.md): Retrieves a specific recurring payment authorization by its recurrence ID (idRec).
- [Get available payment methods](https://developer.paymee.com.br/api-reference/get-available-payment-methods.md): Returns the list of payment methods currently enabled for the merchant.
- [Get payer information](https://developer.paymee.com.br/api-reference/get-payer-information.md): Returns PIX payer details for a **PAID** sale identified by `sale_uuid`.
- [Get pix data from a sale](https://developer.paymee.com.br/api-reference/get-pix-data-from-a-sale.md): To query a transaction, do a GET as shown below.
- [Get plan by ID](https://developer.paymee.com.br/api-reference/get-plan-by-id.md): Retrieves a specific plan by its ID.
- [Get scheduled payment by instruction ID](https://developer.paymee.com.br/api-reference/get-scheduled-payment-by-id.md): Retrieves a specific scheduled payment by its instruction ID.
- [Overview](https://developer.paymee.com.br/api-reference/introduction.md): Introduction to integrating with the PayMee API, covering purpose, requirements, and environments.
- [List authorizations](https://developer.paymee.com.br/api-reference/list-authorizations.md): Lists recurring payment authorizations based on provided filters.
- [List recurrence plans](https://developer.paymee.com.br/api-reference/list-plans.md): Lists Pix Automatic plans based on provided filters.
- [List scheduled payments](https://developer.paymee.com.br/api-reference/list-scheduled-payments.md): Lists scheduled payments (payment instructions) based on filters.
- [Authorize payout](https://developer.paymee.com.br/api-reference/payouts/authorize-payout.md): Authorize Payout
- [Batch payout request](https://developer.paymee.com.br/api-reference/payouts/batch-payout-request.md): Payouts at PayMee are cash-out transactions;
- [Cancel a payout](https://developer.paymee.com.br/api-reference/payouts/cancel-a-payout.md): Before we start, there are some important notes:  1. the transactions should have **PENDING** status and not marked as **IN PROCESSING**
- [Individual payout request](https://developer.paymee.com.br/api-reference/payouts/individual-payout-request.md): Payouts at PayMee are cash-out transactions;
- [Query a transaction](https://developer.paymee.com.br/api-reference/query-a-transaction.md): Returns detailed information about a sale, payout or refund transaction.
- [Query webhook requests](https://developer.paymee.com.br/api-reference/query-a-webhook-requests.md): Returns every webhook attempt associated with the specified transaction. Optional query parameters let you filter by endpoint, event type, status, or HTTP response code.
- [Query current balance](https://developer.paymee.com.br/api-reference/query-current-balance.md): Returns the merchant’s current balance, the timestamp when the balance was calculated (GMT‑3), and a status/message pair indicating success or failure.
- [Query transactions using filters](https://developer.paymee.com.br/api-reference/query-transactions-using-filters.md): Use the query parameters to filter the list of transactions returned.
- [Request a sale refund](https://developer.paymee.com.br/api-reference/request-a-sale-refund.md): Creates a refund request for a **PAID** sale. The body must include the amount to refund and may include a reason and a callback URL.
- [Request a webhook redeliver](https://developer.paymee.com.br/api-reference/request-a-webhook-redeliver.md): Triggers a new delivery attempt for the webhooks of a **SALE** transaction whose payment status is **PAID**.
- [Sandbox and Tools](https://developer.paymee.com.br/api-reference/sandbox-tools.md): Information about the PayMee Sandbox environment for testing integrations and obtaining credentials.
- [Solution Features](https://developer.paymee.com.br/api-reference/solution-features.md): Key attributes and benefits of the PayMee API platform technology.
- [Webhook Notifications](https://developer.paymee.com.br/api-reference/webhook.md): Receiving real-time event notifications from PayMee via webhooks, including authentication, examples, and response formats.

## OpenAPI Specs

- [openapi](https://developer.paymee.com.br/api-reference/openapi.json)

## Optional

- [Help](https://paymee.com.br/ajuda/)