Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
GET
https://api.pagstar.com/api/v2/identity/partner/get-tenant
This documentation describes how to perform a payment with Pix QR Code
If the customer pays the pix through his banking application, Pagstar will send a notification using webhook.
Fields with * are required. The others are considered optional.
The fields name and document are optionals, but we recommend tha you use both to reduce fraude. If you pass the name, the document field will be required. If you submit a document, the name field will be required. Either you send both data, or you send none.
POST
https://api.pagstar.com/api/v2/wallet/partner/transactions/generate-anonymous-pix
PIX is a free instant method of paying in Brazil. It is offered and processed by BACEN (Brazil's Central Bank). Customer may pay the PIX generated by this endpoint on his/her personal bank app.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
The default expiration time for a qrcode is 3600 seconds.
Minimum value to payment is 0,20 BRL
Maximum value to payment is 10.000,00 BRL
To create your payment screen, you can convert the data.pix_key property to an image, or use data.qr_code_url which is in image format. For the copy and paste, use the data.pix_key property
To perform the payment tests, we recommend using the documents below:
We also provide a transparent checkout to reduce your development time. To use it, simply use the data.checkout property of the response json.
We recommend that you create your checkout screen on your site, many users do not like to switch sites to make payments.
Basically it's a "let me know back at a certain URL when you have updates on this transaction". When Pagstar finalizes the processing of a transaction, you will receive on your configured URL the status of it.
Once you have created a transaction, your application makes several requests to Pagstar to check the status of the transaction, until Pagstar returns that it has been paid.
Pix is the Brazilian instant payment. The payment method created by the Central Bank (BC) in which funds are transferred between accounts in a few seconds, any time or day. It is practical, fast and secure. For more details, visit the Central Bank's website.
In this documentation it is described how to create a QR code Pix to receive a payment from your customer.
This documentation describes how to perform a transfer.
This documentation describes how to check the balance of your Pagstar account.
Basically it's a "let me know back at a certain URL when you have updates on this transaction". When Pagstar finalizes the processing of a transaction, you will receive on your configured URL the status of it.
Once you have created a transaction, your application makes several requests to Pagstar to check the status of the transaction, until Pagstar returns that it has been paid.
Now that you have a login and password, you can make a request to our authorization endpoint, as detailed below:
Fields with * are required. The others are considered optional.
POST
https://api.pagstar.com/api/v2/identity/partner/login
The access token is valid for 5 years, after which you will need to generate a new token to continue using the APIs.
All requests to the Pagstar API:
Are encrypted, we do not accept requests using the HTTP protocol, only HTTPS.
The data communication format is JSON. Every request with a JSON payload must contain the header Content-Type: application/json
The obtained access token is the token that you need to pass in the header of all subsequent requests.
It should contain the header User-Agent to tell us the name of your company and a contact email. Here is a sample pattern:
Authorization: Bearer {accessToken}
User-Agent: Company X (contato@empresax.com)
The Status API contains the endpoints to get more details of a transfer and also a quick status check.
Fields with * are required. The others are considered optional.
To check the status of payments (deposits) you can use the endpoints below
GET
https://api.pagstar.com/api/v2/wallet/partner/transfers/:external_reference/check
Returns transaction info
Name | Type | Description |
---|
Name | Type | Description |
---|
The Status API contains the endpoints to get more details of a payment and also a quick status check.
Fields with * are required. The others are considered optional.
To check the status of payments (deposits) you can use the endpoints below
HEAD
https://api.pagstar.com/api/v2/wallet/partner/transactions/:external_reference/check
Check transaction status with HTTP status-only
Name | Type | Description |
---|
Name | Type | Description |
---|
GET
https://api.pagstar.com/api/v2/wallet/partner/transactions/:external_reference
Returns transaction info
This documentation describes how to perform a transfer.
The transfer process starts with a request. This request may be denied for invalid data, by the customer's KYC, or by the bank.
In case of success, we have to wait for the response from the customer's bank. The customer's bank may take some time to respond, due to instabilities in the banking system or in their internal system. The answer will be sent via webhook if the transfer was approved or cancelled.
Fields with * are required. The others are considered optional.
POST
https://api.pagstar.com/api/v3.1/wallet/partner/withdrawals/solicit-for-customer
A PIX keys are aliases for customer's bank account. With these keys, you may transfer to customer with ease and simplicity.
Name | Type | Description |
---|
Name | Type | Description |
---|
POST
https://api.pagstar.com/api/v3.1/wallet/partner/pix-key/transfer
A PIX keys are aliases for customer's bank account. With these keys, you may transfer to customer with ease and simplicity.
For a transfer to be completed, the customer's KYC must be approved.
The transfer is only performed if the owner of the pix key has the same ownership as the requester.
Minimum value to transfer is 0,20 BRL
Maximum value to transfer is 49.000,00 BRL
To perform the transfers tests, we recommend using the documents below:
To check a customer's KYC status, use the documentation below.
Don't forget to configure the webhook to receive the events in real time.
Once you have created a transaction, your application makes several requests to Pagstar to check the status of the transaction, until Pagstar returns that it has been user received.
This page contains two methods for checking the status of a transaction. You can use pooling or webhook.
To check the status of payments (deposits) you can use the endpoints below
To check the status of transfers (withdrawal) you can use the endpoints below
Monitor via webhook to receive notifications and have the status of your payments and transfers updated in real time.
Here you will find all documentation related to the Pagstar API. Below are some general guidelines on how to use our products.
Production environment used to make the product work. The credentials of this environment are sent only after signing the contracts with the company.
After the sandbox testing is complete, contact our support team to enable the production environment for your account and provide the outgoing IP of your machine, so that our cyber security team can configure it.
With webhooks you can enter a URL of your application that is available to the Internet, to receive notifications regarding status changes of payments and transfers from Pagstar.
Fields with * are required. The others are considered optional.
PATCH
https://api.pagstar.com/api/v2/identity/partner/notification-url
All events are sent via a HTTP/HTTPS POST request with the JSON format in the payload.
We recommend for security reasons to only accept notifications from IP 3.128.119.90
Your endpoint must return a success status code in the response, where (2xx) is a valid format, so we will consider it as delivered. Otherwise, we will retry to deliver the notification 2 more times, after which we will no longer attempt to deliver the notification for this event.
A notification that has already been sent can be sent via the panel, or if the settlement bank sends us the approval event again.
The example below is an example of an event payload that we sent.
Webhook containing information update of a payment transaction
Example of approved payment, using the old format
Example of a canceled payment, using the old format
Example of approved payment, using the new format
Example of a canceled payment, using the new format
The properties end2end is not used for payments and user_id is only used for payments with the Pagstar digital wallet.
Payments are only cancelled after 1 hour of expiration time.
Webhook containing information update of a transfer transaction
Example of approved transfer, using the old format
Example of canceled transfer, using the old format
Example of approved transfer, using the new format
Example of canceled transfer, using the new format
The user_id property is only used for payments with Pagstar's digital wallet.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Pix key type | Pix key | Format |
---|
Environment | URL |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Authorization*
String
Bearer token
Content-Type*
String
application/json
User-Agent*
String
Empresa X (contato@empresa.com)
Content-Type* | String | application/json |
User-Agent* | String | Company X (contato@empresa.com) |
email* | String | Partner registered email to login |
access_key* | String | Registered password |
external_reference* | String | Pagstar transaction reference |
Authorization* | String | Bearer token |
Content-Type* | String | Empresa X (contato@empresa.com) |
User-Agent* | String | application/json |
external_reference* | String | Pagstar transaction reference |
Authorization* | String | Bearer token |
Content-Type* | String | Empresa X (contato@empresa.com) |
User-Agent* | String | application/json |
Authorization* | String | Bearer token |
User-Agent* | String | Empresa X (contato@empresa.com) |
Content-Type* | String | application/json |
value* | numeric | Amount to be transferred in real unit, and consider cents as decimal |
pix_key* | String | A pix key of customer's bank account |
transaction_id | String | Your system reference |
CPF | 525.291.198-30 or 52529119830 | \D{11} |
bender@futurama.com | \S+@\S+.\S+ |
TELEFONE | +55 (42) 98753-9319 or +5542987539319 | \+55\D{11} |
CHAVE_ALEATÓRIA | 4bd7ffe4-e69f-11ed-a05b-0242ac120003 | UUID |
Authorization* | String | Bearer token |
User-Agent* | String | Empresa X (contato@empresa.com) |
Content-Type* | String | application/json |
notification_url* | String | URL to receive notification |
notify_type | Number | update the webhook format you want to receive |
external_reference* | String | Pagstar transaction reference |
Authorization* | String | Bearer token |
Content-Type* | String | Empresa X (contato@empresa.com) |
User-Agent* | String | application/json |
Authorization*
String
Bearer Token
Content-Type*
String
application/json
User-Agent*
String
Empresa X (contato@empresa.com)
value*
numeric
Amount to be paid in real unit, and consider cents as decimal
callback
String
The callback which the user may be redirected after payment on checkout
tenant_id*
String
ID of the used tenant
name
String
Customer's name
document
String
Customer's document (CPF or CNPJ with or without points)
expiration
numeric
Time in seconds to expire qrcode
transaction_id
String
Your system reference
description
String
Description that appears on the proof of payment. Usually you put the name of the company or website. Maximum 50 characters.
API |
Platform |
Authorization* | String | Bearer token |
User-Agent* | String | Empresa X (contato@empresa.com) |
Content-Type* | String | application/json |
customer_document* | String | Customer's document (CPF or CNPJ with or without points) |
value* | numeric | Amount to be transferred in real unit, and consider cents as decimal |
pix_key* | String | A pix key of customer's bank account |
transaction_id | String | Your system reference |
pix_key_type* | String | CPF, EMAIL, TELEFONE, CHAVE_ALEATORIA |
If you have any problems with our API, feel free to call us by whats +55 (11) 91434-2388 or by e-mail atendimento@pagstar.com