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 current balance

API PayMee 1.1

Introduction to integrating with the PayMee API, covering purpose, requirements, and environments.

Overview

Key attributes and benefits of the PayMee API platform technology.

Solution Features

Overview of the PayMee API integration model, endpoints, and HTTP methods used.

Architecture

Information about the PayMee Sandbox environment for testing integrations and obtaining credentials.

Sandbox and Tools

Receiving real-time event notifications from PayMee via webhooks, including authentication, examples, and response formats.

Webhook Notifications

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.

Semi-transparent wire-transfer, pix and credit card and openbanking checkout

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.

Redirect checkout

Payouts at PayMee are cash-out transactions;

Before we start, there are some important tips:

1. you must have sufficient funds;
2. you shoud provide a valid and complete beneficiary details
3. Register your server CIDR for production enviroment

Individual payout request

Payouts at PayMee are cash-out transactions;

Before we start, there are some important tips:
 1. you must have sufficient funds;
 2. you shoud provide a valid and complete beneficiary details
 3. Register your server CIDR for production enviroment

Batch payout request

Authorize payout

Before we start, there are some important notes:
 1. the transactions should have **PENDING** status and not marked as **IN PROCESSING**

Cancel a payout

Create a loan simulation based on customer information and requested amount

Simulation

Creates a loan based on a previously approved proposal

Create a loan

Returns detailed information about a sale, payout or refund transaction.

Query a transaction

Use the query parameters to filter the list of transactions returned.

Query transactions using filters

To query a transaction, do a GET as shown below.

Get pix data from a sale

Allows the merchant to cancel a **PENDING** sale. Any other situation will return an error.

Cancel a transaction

Returns the list of payment methods currently enabled for the merchant.

Get available payment methods

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 sale refund

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 webhook requests

Triggers a new delivery attempt for the webhooks of a **SALE** transaction whose payment status is **PAID**.

Request a webhook redeliver

Returns PIX payer details for a **PAID** sale identified by `sale_uuid`.

Get payer information

Welcome to the home of your new documentation

Introduction

Start building awesome documentation in under 5 minutes

Quickstart

Preview changes locally to update your docs

Development

Text, title, and styling in standard markdown

Markdown Syntax

Code Blocks

Add image, video, and other HTML elements

Images and Embeds

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Global Settings

The navigation field in mint.json defines the pages that go in the navigation menu

Navigation

Reusable, custom snippets to keep content in sync

Reusable Snippets

Example section for showcasing API endpoints

Returns all plants from the system that the user has access to

Get Plants

Create Plant

Deletes a single plant based on the ID supplied

API Documentation

Checkout

Payouts

Loan

Transactions

Payment Methods

Financial

Webhooks and Callbacks

Payer Information

Query current balance

Headers

Response