Com este serviço o comércio poderá criar as ordens a serem enviadas aos beneficiários utilizando o Pix.
EndPoint: https://stg-payout.wepay4u.com/api/v1/payout_order
HTTP: POST
Authorization: Basic Auth
| Parâmetros | Descrição | Exemplo |
|---|---|---|
| MerchantReference | Código único do comércio para identificar uma transação | VENDA001 |
| Amount | Valor que será realizado o Payout, decimal(18.2) | 120.00 |
| CountryCode | Pais de Origem da transação | ISO-4217 (BRA, PER, COL, ECU, MEX) |
| Immediately | Enviar valor "true" | |
| CurrencyCode | Moeda da transação | ISO-4217 (BRL, PEN, USD, COP) |
| Creation | Data de criação do Payout | ISO 8601: yyyy-MM-ddThh:mm:ss |
| Customer.Info.FirstName | Primeiro nome do beneficiário | João |
| Customer.Info.LastName | Sobrenome do beneficiário | da Silva |
| Customer.Info.DocType | Tipo de documento do beneficiário | CPF, CNPJ |
| Customer.Info.DocNumber | Número de documento do beneficiário | 12345678901 |
| Customer.Info.CountryCode | País do beneficiário | ISO-4217 (BRA, PER, COL, ECU, MEX) |
| Customer.Info.Email | Email do beneficiário | [email protected] |
| Customer.Info.Phone | Número de telefone do beneficiário | +55111111111 |
| Customer.Info.Mobile | Número de celular do beneficiário | +5511999999999 |
| Customer.Info.Address | Endereço do beneficiário | Avenida Paulista, 200 – São Paulo – São Paulo |
| Bank.BankCode | Código ID do banco. Usar valor 1037 | 1037 |
| Bank.PixKey | Tipo de valor da chave Pix | 01 = CPF/CNPJ 02 = Email 03 = Celular em formato +55 DDD+Numero Ex. +5599999999999 04 = Chave Aleatória |
| Bank.PixValue | Valor da chave Pix | [email protected] |
| Bank.TypeAccountBank | Tipo de conta do beneficiário | Corrente |
- Parâmetros com asteriscos são obrigatórios
{
"MerchantReference": "teste31102022_2122",
"Amount": 1.04,
"CountryCode": "BRA",
"Immediately": true,
"CurrencyCode": "BRL",
"Creation": "2022-07-18 06:23:00",
"Customer": {
"Info": {
"FirstName": "João",
"LastName": " de Sousa",
"DocType": "CPF",
"DocNumber": "12345678901",
"CountryCode": "BRA",
"Email": "[email protected]",
"Phone": "11999999999",
"Mobile": "11999999999",
"Address": ""
},
"Bank": {
"BankCode": "1344",
"PixKey": "02",
"PixValue": "12345678901",
"TypeAccountBank": "CORRENTE"
}
}
}
[
{
"PublicID": "Em_prd_4a57923de7mxfyn8",
"MerchantReference": "teste31102022_2123",
"TxCreation": "2022-07-18 06:23:00",
"Amount": 1.04,
"CurrencyCode": "BRL",
"LastStatus": 12,
"Customer": {
"Info": {
"FullName": "JOÃO DA SILVA",
"DocType": "CPF",
"DocNumber": "12345678901",
"Email": "[email protected]",
"Phone": "11999999999",
"Mobile": "11999999999",
"Address": null
},
"Bank": {
"CustomerBank": "STARTBANK",
"CustomerAccountNumber": "",
"CustomerCCI": "",
"TypeAccountBank": "",
"NumberAgence": ""
}
},
"New_balance": "747.94",
"response_date": "2022-11-01 00:28:40"
}
]