Pix

Como usar o Pix para enviar um payout no Brasil.

Criar um payout por PIX no Brasil.

POST https://sandbox.transfersmile.com/api/payout

Este endpoint permite que você submeta um Payout por PIX no Brasil.

Headers

Name	Type	Description
Content-Type*	string	application/json; chartset=UTF-8
AppId*	string	Seu App ID na plataforma de payout
Authorization*	string	SHA256($sorted_params + $app_key)

Request Body

Name	Type	Description
name*	string	Nome do beneficiário - entre 5 e 100 chars -
phone	string	Telefone do beneficiário
email	string	E-mail do beneficiário
document_id*	string	Número de identificação pessoal do beneficiário
account*	string	Conta PIX do beneficiário
account_type*	string	Tipo de conta PIX do beneficiário '- Uma das: CPF, CNPJ, EVP, PHONE, EMAIL -
method*	string	Valor fixo: PIX
custom_code*	string	Merchant Payout ID - Max. 50 chars -
fee_bear*	string	Taxas de processamento para o comerciante ou beneficiário. - Um dos seguintes: merchant, beneficiary -
amount*	number	Valor do Payout, 2 números decimais - Min 0.01, Max 500,000 -
source_currency*	string	Moeda da conta do Merchant - USD, EUR, GBP, BRL -
arrival_currency*	string	Valor fixo: BRL
notify_url*	string	Para onde a pagsmile enviará a Notificação.
additional_remark*	string	Descrição na fatura bancária do usuário - Max length: 40 -
country*	string	BRA para o Brasil
document_type*	string	Tipo de identificação pessoal do beneficiário - CPF ou CNPJ -
amount_type	String	Especificar o montante do valor fixo para o merchant ou beneficiário '- Um de: source_amount, arrival_amount(default) -

200: OK enviado com sucesso

{
    "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"
    }
}

400: Bad Request ordem já existe

{
    "code": 4001010,
    "msg": "order already existed",
    "time": 1628580940,
    "data": {}
}

401: Unauthorized não autorizado

{
    "code": 4004003,
    "msg": "permission denied",
    "time": 1637224716,
    "data": {}
}

500: Internal Server Error erro no servidor

{
    "code": 5001000,
    "msg": "system error",
    "time": 1637224716,
    "data": {}
}

500: Internal Server Error saldo insuficiente

// system error
{
    "code": 5001102,
    "msg": "balance insufficient",
    "time": 1637224716,
    "data": {
        ... ...
    }
}

500: Internal Server Error taxa não configurada

{
    "code": 5001003,
    "msg": "fee not configured",
    "time": 1637224716,
    "data": {
        ... ...
    }
}

Exemplo

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": "[e-mail]",
    * "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
}'

Nota: 94FAC********************** 68548 é o App Id de teste Pagsmile para o ambiente de sandbox, e d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 é o token de autorização associado ao App Id de teste.

No ambiente sandbox, use [e-mail] como conta PIX, e EMAIL como account_type para testar o pagamento REJEITADO(REJECTED), qualquer outra conta PIX será um sucesso (PAID).

Exemplo de conta PIX

Tipo de conta	Conta	Texto
CPF	22*******99	11 dígitos
CNPJ	23**********31	14 dígitos
Phone	[phone]	Sempre comece com +55
Email	[e-mail]
EVP		string alfanumérica de 32 dígitos que é enviada do banco central para a instituição