PSP
Versão super simplificada de um Payment Service Provider (PSP).
Iniciando a aplicação
npm install && npm start
Executando testes
npm test
Endpoints da API
GET /payables
GET /transactions
POST /transactions
Parâmetros para POST /transaction
:
Parâmetro | Obrigatório | Valor |
---|---|---|
value | sim | float |
description | sim | string |
method_payment | sim | credit_card ou debit_card |
card_number | sim | string |
card_holder_name | sim | string |
card_expiry_date | sim | YYYY-MM |
card_cvv | sim | string |
Contexto
Em sua essência um PSP tem duas funções muito importantes:
- Permitir que nossos clientes processem transações ("cash-in")
- Efetuar os pagamentos dos recebíveis para os nossos clientes ("cash-out")
No Pagar.me, nós temos duas entidades que representam essas informações:
transactions
: que representam as informações da compra, dados do cartão, valor, etcpayables
: que representam os recebíveis que pagaremos ao cliente
Requisitos
Você deve criar um serviço com os seguintes requisitos:
- O serviço deve processar transações, recebendo as seguintes informações:
- Valor da transação
- Descrição da transação. Ex:
'Smartband XYZ 3.0'
- Método de pagamento (
debit_card
oucredit_card
) - Número do cartão
- Nome do portador do cartão
- Data de validade do cartão
- Código de verificação do cartão (CVV)
- O serviço deve retornar uma lista das transações já criadas
- Como o número do cartão é uma informação sensível, o serviço só pode armazenar e retornar os 4 últimos dígitos do cartão.
- O serviço deve criar os recebíveis do cliente (
payables
), com as seguintes regras:- Se a transação for feita com um cartão de débito:
- O payable deve ser criado com status =
paid
(indicando que o cliente já recebeu esse valor) - O payable deve ser criado com a data de pagamento (payment_date) = data da criação da transação (D+0).
- O payable deve ser criado com status =
- Se a transação for feita com um cartão de crédito:
- O payable deve ser criado com status =
waiting_funds
(indicando que o cliente vai receber esse dinheiro no futuro) - O payable deve ser criado com a data de pagamento (payment_date) = data da criação da transação + 30 dias (D+30).
- O payable deve ser criado com status =
- Se a transação for feita com um cartão de débito:
- No momento de criação dos payables também deve ser descontado a taxa de processamento (que chamamos de
fee
) do cliente. Ex: se a taxa for 5% e o cliente processar uma transação de R$100,00, ele só receberá R$95,00. Considere as seguintes taxas:- 3% para transações feitas com um cartão de débito
- 5% para transações feitas com um cartão de crédito
- O serviço deve prover um meio de consulta para que o cliente visualize seu saldo com as seguintes informações:
- Saldo
available
(disponível): tudo que o cliente já recebeu (payablespaid
) - Saldo
waiting_funds
(a receber): tudo que o cliente tem a receber (payableswaiting_funds
)
- Saldo
Nota: neste desafio, você não precisa se preocupar com parcelamento.
Restrições
- O serviço deve ser escrito em Node.js
- O serviço deve armazenar informações em um banco de dados. Você pode escolher o banco que achar melhor. Aqui no Pagar.me usamos amplamente PostgreSQL
- O projeto deve ter um README.md com todas as instruções sobre como executar e testar o projeto e os serviços disponibilizados.