Tipo de integração na qual o comércio obtém as instruções para pagamento via Transferência Bancária e possa adicioná-los dentro de seu sistema.
Atualmente trabalhamos com os seguintes bancos:
- Bradesco
- Banco Itaú
- Banco do Brasil
- Santander
- Bancos digitais
EndPoint: https://stg-payment.wepay4u.com/api/v1/payment_order
HTTP: POST
Authorization: Basic Auth
Parâmetros | Descrição | Exemplo |
---|---|---|
MerchantSalesID* | Código único do comércio para identificar uma transação | VENDA001 |
Details | Descrição da crobrança, poderá ser um número ou descrição do produto/serviço | Recuperação de venda |
CustomCheckout* | Tipo de checkout White-Label ou Redirect. | true: Para White-Label |
Immediately* | Valor fixo | true |
Amount* | Valor da transação | 100.00 |
CountryCode* | País de origem do pedido | BRA, PER, COL, ECU, MEX |
CurrencyCode* | Moeda que a transação será gerada | BRL, PEN, COP, USD, MXN |
CreationDate* | Data de criação da transação | 2022-07-27 11:19:58 |
TimeExpired* | Tempo de expiração da transação enviado em minutos | 120 |
ErrorURL* | Url que o shopper será redirecionado em caso da não confirmação ou expiração da transação | https://www.meusite/nosuccess |
OkURL* | Url que o shopper será redirecionado em caso da confirmação do pagamento | https://www.meusite/confirmado |
Customer.Address | Endereço do shopper. Utilizado para transação de boleto bancário | Rua José de Sousa, 123 - 6to andar - São Paulo - SP - CEP: 01234-123 |
Customer.CountryCode | País de origem do shopper | BRA, PER, COL, ECU, MEX |
Customer.DocNumber* | Número de documento do shopper | 12345678901 |
Customer.DocType* | Tipo de documento do Shopper | CPF, CNPJ |
Customer.Email | Email de contato do shopper | [email protected] |
Customer.FirstName | Primeiro nome no shopper | João |
Customer.LastName | Sobrenome do shopper | Sousa |
Customer.Mobile | Número de celular do shopper | 11999999999 |
- Parâmetros com asteriscos são obrigatórios
{
"MerchantSalesID": "TEST_2707202201",
"Details": "",
"CustomCheckout": true ,
"Immediately": true,
"Amount": 1.10,
"CountryCode": "BRA",
"CurrencyCode": "BRL",
"CreationDate": "2022-07-27 11:19:58",
"TimeExpired": 120 ,
"ErrorURL": "https://loja.com.br/ok",
"OkURL": "https://loja.com.br/error",
"Customer": {
"Address": "Rua Cerro Corá, 2175 - 6to andar",
"CountryCode": "BRA",
"DocNumber": "12345678901",
"DocType": "CPF",
"Email": "[email protected]",
"FirstName": "João",
"LastName": "Sousa",
"Mobile": "11999999999"
}
}
{
"PublicID": "Em_9482f028u92ith",
"Token": "15d950b8340d885d39e92e8c5db8ce092867deca",
"Created": "2022-06-28 11:19:58",
"Expiration": "2022-06-28 13:19:58",
"MerchantCode": 1001,
"PaymentCode": "12345678901161",
"Transaction": {
"MerchantSalesID": "TEST_2707202201",
"Amount": 1.1,
"ShopperAmount": 1.1,
"iof": 0,
"CurrencyCode": "BRL",
"Creation": "2022-06-28 11:19:58",
"TimeExpired": "2022-06-28 13:19:58",
"ErrorURL": "https://loja.com.br/ok",
"OkURL": "https://loja.com.br/error",
"Status": 10,
"Customer": {
"FullName": "João Sousa",
"FirstName": "João",
"LastName": "Sousa",
"DocType": "CPF",
"DocNumber": "12345678901",
"CountryCode": "BRA",
"Email": "[email protected]",
"Phone": "",
"Mobile": "11999999999",
"Address": "Rua Cerro Corá, 2175 - 6to andar"
}
},
"InstructionsPaymemt": {
"TransferOnline": {
"banks": [
{
"BankIndex": 1,
"BankCode": 1019,
"ShortName": "NOME DO BANCO",
"UrlLogo": "https://dev-banks.s3.us-east-2.amazonaws.com/Brasil/NomedoBanco/NomedoBanco.png",
"BankName": "NOME DO BANCO",
"CountryCode": "BRA",
"UrlBank": "https://www.nomedobanco.com.br",
"Color": "#00286e",
"WorkHours": "n/a",
"Version": "1.0",
"RequireAgenceAndAccount": true,
"Instructions": [
{
"step": 1,
"icon": null,
"text": "Realize a Transferência conforme instrução abaixo",
"acount": "1948090195038",
"cci": "19480901950382552"
},
{
"step": 2,
"icon": null,
"text": "No seu app ou Internet Banking vá até a opção <b>\"Fazer Transferência\"</b>"
},
{
"step": 3,
"icon": null,
"text": "Ingresse os dados de agência e conta"
},
{
"step": 4,
"icon": null,
"text": "Ingresse <b>exatamente o valor indicado para pagamento.</b> Caso contrário, sua compra poderá não ser processada."
},
{
"step": 5,
"icon": null,
"text": "Revise o favorecido <b>WePay4u Brasil Serviços de Pagamentos Ltda</b>"
},
{
"step": 6,
"icon": null,
"text": "Pronto!, só confirmar a transferência e aguardar a notificação de pagamento ser enviada à loja."
}
]
},
],
"shopper": {
"FirstName": "João",
"LastName": "Sousa",
"FullName": "João Sousa",
"DocType": "CPF",
"DocNumber": "12345678901",
"Email": "[email protected]",
"Mobile": "11999999999"
}
},
}
}
Customer Payment
Utilizado nas integrações White-Label, apenas para os bancos “Itaú” e “Banco do Brasil” nas modalidades de Transferência Bancária.
O comércio deverá solicitar via “front”, os dados de Agência e Número de conta para o shopper, e posterior a isso deverá consumir este método para nos enviar as informações bancárias. Para os demais bancos não há necessidade de solicitar informação adicional ao shopper.
EndPoint: https://stg-payment.wepay4u.com/api/v1/payment_order/store_customer_payment
HTTP: POST
Authorization: Basic Auth
Parâmetros | Descrição | Exemplo |
---|---|---|
PublicId | Id da WePay4u obtido no Response do método de criação da transação. | Em_stg_9807ab490b5wne |
SameShopper | Valor fixo | true |
MetaData.NumberAgence | Número de agência do shopper | 1234-5, 1234 |
MetaData.NumberAccount | Número da conta do Shopper | 123456-0, 123456 |
{
"PublicID": "Em_stg_9807ab490b5wne",
"SameShopper": true,
"MetaData": {
"NumberAgence": "1234",
"NumberAccount": "96333-3"
}
}
{
"status": true,
"message": "Customer created",
"data": {
"CustomerDetailID": 6282,
"CustomerID": 1308,
"TransactionID": 4739,
"Email": "[email protected]",
"Phone": "",
"Mobile": "11999999999",
"Address": "Rua Cerro Corá, 2175 - 6to andar",
"created_at": "2022-03-29 14:14:48",
"updated_at": "2022-03-29 14:24:10",
"MetaData": {
"NumberAgence": "1234",
"NumberAccount": "12345-6"
}
}
}
Esse método deverá ser consumido apenas para os checkouts White-Label após a criação da transação.