Introduction

Authentication

Test cards

Establishments

Users

Customers

Cards

Payment links

Error codes

Payment Split

Products

Discount Coupons

Sales

Signatures

Webhooks

Financial


On this page:


Primefy allows you to efficiently implement the best payment solution for your business with just a few lines of code.

The purpose of Primefy's API is to enable payment transactions made with Credit Cards, Boleto Bancário (Bank Bills) and PIX, whether single or recurring. You will also be able to manage payment transactions through capture, cancellation or refund, in addition to being able to include subscription plans for your products and services.

<aside> 💡 Not a professional in the development field? We offer free technical support to all our customers. Contact us to receive the assistance you need — no coding knowledge is required.

</aside>

API Reference

The Primefy API is developed using a RESTful framework. It has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Endpoint

<https://api.premepay.com/v1>

Test Mode

The Primefy API is also available in a test environment - Staging. This means that during the setup process until the official integration launch, active data from our clients' platforms is not affected, and there is no real interaction with their banking networks. All of this is done to ensure the security of the integration procedure and high levels of performance and accuracy after its launch.

<https://premeapi-staging.premepay.com/v1>

Related Content

<aside> <img src="/icons/command-line_red.svg" alt="/icons/command-line_red.svg" width="40px" /> Authentication

</aside>