Pix
Cómo utilizar PIX para enviar un payout en Brasil.
Enviar un payout por PIX en Brasil.
POST
https://sandbox.transfersmile.com/api/payout
Este endpoint te permite usar Pix para realizar un payout en Brasil.
Headers
Content-Type*
string
application/json; chartset=UTF-8
AppId*
string
APP ID en la plataforma de payout
Authorization*
string
SHA256($sorted_params + $app_key)
Request Body
name*
string
Nombre de beneficiario - Largo entre 5 y 100 -
phone
string
Teléfono de beneficiario
string
Correo de beneficiario
document_id*
string
Número de identificación de beneficiario
account*
string
Cuenta Pix de beneficiario
account_type*
string
Tipo de cuenta pix de beneficiario - Sólo uno: CPF, CNPJ, EVP, PHONE, EMAIL -
method*
string
Valor Fijo:
PIX
custom_code*
string
Payout ID de merchant - Max. 50 chars -
fee_bear*
string
Tarifa de procesamiento se carga a merchant o beneficiario. - Sólo uno: merchant beneficiario -
amount*
number
Monto de Payout
- Max. 2 números decimales
- Min 0.01, Max 500,000 -
source_currency*
string
Moneda de cuenta de merchant - Sólo uno: USD, EUR, GBP, BRL -
arrival_currency*
string
Valor Fijo: BRL
notify_url*
string
Donde Pagsmile enviará la notificación
additional_remark*
string
Descriptor en la factura bancaria del usuario - Max long: 40 -
country*
string
BRA por Brasil
document_type*
string
Tipo de identificador del beneficiario
- Sólo uno: CPF, CNPJ -
amount_type
String
Especificar el monto es fijo para merchant o beneficiario - Sólo uno: source_amount, arrival_amount(defecto) -
{
"code": 200,
"msg": "success",
"time": 1628580845,
"data": {
"id": "S202108100734054iRiUZFPXfQM",
"custom_code": "custom_code9982674851738108",
"arrival_amount": "0.51",
"arrival_currency": "BRL",
"source_amount": "0.07",
"source_currency": "USD",
"status": "IN_PROCESSING"
}
}
Ejemplo
curl --location --request POST 'https://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
* "name": "GUILHERME ****** SOUZA",
"phone": "",
"email": "payout@pagsmile.com",
* "amount": 150,
* "arrival_currency": "BRL", // fixed value: BRL
* "custom_code" : "custom_code9982674851738108",
* "document_id": "22*******99",
* "document_type": "CPF",
* "fee_bear": "merchant",
* "method": "PIX", // fixed value: PIX
* "notify_url": "https://notify.url",
* "account": "22*******99",
* "account_type": "CPF", // should be one of CPF CNPJ PHONE EMAIL EVP
* "source_currency": "BRL",
* "additional_remark": "pagsmile payout test remark",
* "country": "BRA", // fixed value: BRA
}'
En ambiente sandbox, favor usar pagsmile_test_reject@pagsmile.com
como cuenta PIX, y EMAIL como account_type para pruebas de REJECTED payout, cualquier otra cuenta PIX será exitosa (PAID).
Ejemplo de cuenta PIX
CPF
22*******99
11 dígitos
CNPJ
23**********31
14 dígitos
Phone
+5511987654321
Siempre empieza con +55
merchant@pagsmile.com
EVP
string alfanumérico de 32 dígitos enviado del Banco Central a la institución
Last updated