API de autenticação
URL sandbox: https://authsandbox.braspag.com.br
URL produção: https://auth.braspag.com.br
| Método | Endpoint | Descrição |
|---|---|---|
post | /oauth2/token | Cria um token de acesso. |
Configuração de notificações
URL sandbox: https://splitonboardingapisandbox.braspag.com.br
URL produção: https://splitonboardingapi.braspag.com.br
| Método | Endpoint | Descrição |
|---|---|---|
post | /api/merchant-notification | Configura um webhook para receber notificações |
put | /api/merchant-notification | Atualiza o webhook de notificações |
get | /api/merchant-notification/{MerchantId} | Consulta URL de notificação |
API de onboarding
URL sandbox: https://splitonboardingapisandbox.braspag.com.br
URL produção: https://splitonboardingapi.braspag.com.br
| Método | Endpoint | Descrição |
|---|---|---|
post | /api/merchants | Cadastra um seller vinculado a um master no Split de Pagamento. |
get | /api/merchants/{merchant-id} | Consulta os dados e status do seller. |
put | /api/agreements/batch | Altera o mesmo conjunto de taxas para todos os sellers de um lote. |
PATCH | /api/v2/agreements/batch | Habilita o meio de pagamento Pix em lote para sellers já cadastrados. |
get | /api/v2/agreements/batch/{requestId} | Consulta se a alteração realizada em lote para Pix foi feita com sucesso para cada seller. |
post | /api/merchants/{MerchantId}/bank-account/request-update | Atualiza os dados bancários de um seller específico. |
Split de Pagamento pelo Gateway de Pagamento
API transacional
URL sandbox: https://apisandbox.braspag.com.br
URL produção: https://api.braspag.com.br
| Método | Endpoint | Descrição |
|---|---|---|
post | /v2/sales | -Cria pagamentos (para cada meio de pagamento); -Cria recorrências; -Salva cartões durante a autorização; -Cria pagamentos com antifraude. |
put | /v2/sales/{PaymentId}/capture | Captura transação de crédito total pelo PaymentId. |
put | /v2/sales/{PaymentId}/capture?amount={amount} | Captura transação de crédito parcial pelo PaymentId. |
put | /v2/sales/{PaymentId}/void | - Cancela uma transação total; -Solicita devolução Pix total ou parcial. |
put | /v2/sales/{PaymentId}/void?amount={amount} | Cancela parcialmente uma transação. |
put | v2/RecurrentPayment/{RecurrentPaymentId}/Payment | Altera os dados do pagamento recorrente |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/NextPaymentDate | Altera a data do próximo pagamento recorrente |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Amount | Altera o valor da recorrência |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay | Altera o dia da recorrência |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Interval | Altera o intervalo da recorrência |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/EndDate | Altera a data final da recorrência |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Customer | Altera dados do comprador em um pagamento recorrente. |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Deactivate | Desabilita um pedido recorrente |
put | /v2/RecurrentPayment/{RecurrentPaymentId}/Reactivate | Reabilita um pedido recorrente |
API de consulta transacional
URL sandbox: https://apiquerysandbox.braspag.com.br
URL produção: https://apiquery.braspag.com.br
| Método | Endpoint | Descrição |
|---|---|---|
get | /v2/sales/{PaymentId} | Consulta transação pelo PaymentId. |
Split de Pagamento pela API E-commerce Cielo
API transacional
URL sandbox: https://apisandbox.cieloecommerce.cielo.com.br/1/sales
URL produção: https://api.cieloecommerce.cielo.com.br/1/sales
| Método | Endpoint | Descrição |
|---|---|---|
post | /1/sales | -Cria pagamentos (para cada meio de pagamento); -Cria recorrências; -Salva cartões durante a autorização; -Cria pagamentos com antifraude. |
put | /1/sales/{PaymentId}/capture | Captura transação de crédito total ou parcial pelo PaymentId. |
put | /1/sales/{PaymentId}/void | Cancela uma transação total. |
put | /1/sales/{PaymentId}/void?amount={amount} | Cancela parcialmente uma transação. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Payment | Altera os dados do pagamento recorrente |
put | /1/RecurrentPayment/{RecurrentPaymentId}/NextPaymentDate | Altera a data do próximo pagamento recorrente |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Amount | Altera o valor da recorrência |
put | /1/RecurrentPayment/{RecurrentPaymentId}/RecurrencyDay | Altera o dia da recorrência |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Interval | Altera o intervalo da recorrência |
put | /1/RecurrentPayment/{RecurrentPaymentId}/EndDate | Altera a data final da recorrência |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Customer | Altera dados do comprador em um pagamento recorrente. |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Deactivate | Desabilita um pedido recorrente |
put | /1/RecurrentPayment/{RecurrentPaymentId}/Reactivate | Reabilita um pedido recorrente |
API de consulta transacional
URL sandbox: https://apiquerysandbox.cieloecommerce.cielo.com.br/
URL produção: https://apiquery.cieloecommerce.cielo.com.br/
| Método | Endpoint | Descrição |
|---|---|---|
get | /1/sales/{PaymentId} | Consulta transação pelo PaymentId. |
Split pós-transacional
URL sandbox: https://splitsandbox.braspag.com.br/
URL produção: https://split.braspag.com.br/
| Método | Endpoint | Descrição |
|---|---|---|
put | /api/transactions/{PaymentId}/split | Realiza a divisão de um pagamento que já foi autorizado. |
get | /api/transactions/{PaymentId}/split?masterRateDiscountType=Sale | Configura as taxas entre master e seller para uma transação já autorizada. |
Split de pagamentos na maquininha
URL produção: https://split.braspag.com.br/
| Método | Endpoint | Descrição |
|---|---|---|
post | /api/transactions | Divide um pagamento criado pela Cielo LIO |
get | /api/transactions/{Id} | Consulta transação no mundo físico |
get | /api/v1/pending-creation-transactions | Consulta transações pendentes de criação. |
put | /transactions/{PaymentId}/void?amount={amount} | Cancela um valor parcial da transação. |
put | /transactions/{PaymentId}/void | Cancela o valor total de uma transação. |
get | /transactions/{TransactionId}/voids/{voidId} | Consulta o status do pedido de cancelamento parcial ou total. |
Antecipação de recebíveis
URL produção: https://splitsandbox.braspag.com.br/anticipation-api
| Método | Endpoint | Descrição |
|---|---|---|
post | /merchants/{merchantId}/receivable-anticipations | Solicita a antecipação de recebíveis para o master ou para o seller. |
post | /merchants/{merchantId}/receivable-anticipations/simulation | Simula o cadastro de antecipações para o master. |
get | /merchants/{MerchantId}/receivable-anticipations/{AnticipationId} | Consulta uma antecipação pelo identificador da antecipação e do lojista (MerchantId). |
Extrato eletrônico
URL sandbox: https://splitsandbox.braspag.com.br/schedule-api
URL produção: https://split.braspag.com.br/schedule-api
| Método | Endpoint | Descrição |
|---|---|---|
get | /v2/electronic-statement | Retorna o extrato eletrônico. |
Conciliação no Split de Pagamentos
URL sandbox: https://splitsandbox.braspag.com.br/schedule-api
URL produção: https://split.braspag.com.br/schedule-api
| Método | Endpoint | Descrição |
|---|---|---|
get | /v1/receivables | Consulta as URs de acordo com os filtros disponíveis. |
get | /v1/ReconciliationSchedules | Consulta agenda de acordo com os filtros disponíveis. |
Tratamento de contestações - Chargeback
URL produção: https://split.braspag.com.br/chargeback/dispute
| Método | Endpoint | Descrição |
|---|---|---|
get | /dispute | Consulta uma contestação e retorna o ciclo de vida da defesa. |
put | /{DisputeId}/accept | Aceita um chargeback. |
put | /{DisputeId}/refuse | Recusa e inicia a defesa de um chargeback. |