Pix

Como usar o Pix para enviar um payout no Brasil.

Post

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

Criar um payout por PIX no Brasil

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

Parameters


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

Body


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
document_type*	string	Tipo de identificação pessoal do beneficiário - CPF ou CNPJ -
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	ID de Payout do merchant - Max. 50 chars -
fee_bear*	string	Taxas de processamento para o comerciante ou beneficiário. - Um dos seguintes: merchant, beneficiary -
amount*	string	Valor do Payout, 2 números decimais - Min 0.01, Max 500,000 -
amount_type	string	Especificar o montante do valor fixo para o merchant ou beneficiário '- Um de: source_amount, arrival_amount(default) -
source_currency*	string	Moeda da conta do Merchant - USD, EUR, GBP, BRL -
arrival_currency*	string	Valor fixo: BRL
notify_url*	string	Para onde a transfersmile 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

Responses


200: OK	enviado com sucesso

{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQM",
        "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	taxa não configurada

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


500: Internal Server Error	saldo insuficiente

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


500: Internal Server Error	erro no servidor

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

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

Tips

No ambiente sandbox, use **[email protected]_** 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	+5511987654321	Sempre comece com +55
Email	`[email protected]_`
EVP		string alfanumérica de 32 dígitos que é enviada do banco central para a instituição