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.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Pix key type | Pix key | Format |
---|---|---|
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
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