Introdução

A conciliação permite acessar informações de agenda financeira, para que você tenha controle de todos os eventos relacionados às suas vendas e de seus subordinados.

Ambientes

Existem dois ambientes distintos para a integração com a API: o ambiente Sandbox e o ambiente de Produção.
No ambiente Sandbox, podem ser realizados a homologação e os testes de sua integração. Já no ambiente de Produção, são realizadas as transações reais.

Para executar uma operação:

  1. Combine a base da URL do ambiente com o endpoint da operação desejada. Ex.: https://authsandbox.braspag.com.br/oauth2/token.
  2. Envie a requisição para a URL utilizando o método HTTP (GET, POST ou PUT) adequado à operação.

Sandbox

Tipo URL Base Descrição
API Split https://splitsandbox.braspag.com.br/ Para requisições de agenda financeira, chargeback, liquidação e antecipação.
Braspag OAUTH2 Server https://authsandbox.braspag.com.br/ Para requisição de autenticação.

⚠ Solicite suas credenciais para o ambiente de teste com o nosso Suporte.

Produção

Tipo URL Base Descrição
API Split https://split.braspag.com.br/ Para requisições de agenda financeira, chargeback, liquidação e antecipação.
Braspag OAUTH2 Server https://auth.braspag.com.br/ Para requisição de autenticação.

Autenticação

O Split de Pagamentos utiliza como segurança o protocolo OAuth 2.0. É necessário primeiramente obter um token de acesso, utilizando suas credenciais. O token deverá posteriormente ser enviado à API do Split.

Para obter um token de acesso:

  1. Concatene o MerchantId e ClientSecret: MerchantId:ClientSecret.
  2. Codifique o resultado da concatenação em Base64.
  3. Realize uma requisição ao servidor de autorização utilizando o código alfanumérico gerado.

Segue exemplo de requisição a ser enviada:

Requisição

x-www-form-urlencoded
--header "Authorization: Basic {base64}"  
--header "Content-Type: application/x-www-form-urlencoded"  
grant_type=client_credentials

Resposta

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbG.....WE1igNAQRuHAs",
    "token_type": "bearer",
    "expires_in": 1199
}

O token retornado (access_token) deverá ser utilizado em toda requisição à API Split como uma chave de autorização. O access_token possui uma validade de 20 minutos, e é necessário gerar um novo token toda vez que a validade expirar.

Agenda Financeira

No Split de Pagamentos, o responsável por realizar o repasse dos valores (liquidação) a cada um dos participantes de uma venda é a Braspag (Facilitador).
A Braspag irá gerar uma agenda financeira que poderá ser consultada a qualquer momento pelo Marketplace e/ou Subordinados. Essa agenda é composta por eventos de Crédito e Débito que são gerados de acordo com as operações efetuadas e o regime de pagamento acordado.

Em uma consulta ou ajuste na agenda, os seguintes valores podem ser retornados no campo Schedules.EventDescription, em resposta à requisição:

Eventos de Crédito:

Id Evento Descrição
1 Credit Lançamento de crédito das parcelas de uma transação.
3 FeeCredit Lançamento de crédito da tarifa fixa acordada entre o Marketplace e a Braspag (Facilitador).
5 RefundCredit Lançamento de crédito devido a um cancelamento.
7 ChargebackCredit Lançamento de crédito devido a um chargeback.
9 UndoChargebackCredit Lançamento de crédito para reversão de um chargeback.
11 AntiFraudFeeCredit Lançamento de crédito referente à transação de antifraude.
13 AntiFraudFeeWithReviewCredit Lançamento de crédito referente à transação de antifraude com revisão manual.
15 AdjustmentCredit Lançamento de um crédito como ajuste.
17 ChargebackReversalCredit Lançamento de crédito referente à reversão de um chargeback.
19 AnticipationCredit Lançamento de crédito referente a antecipação.
20 AnticipationCommissionCredit Lançamento de crédito referente à comissão de uma antecipação.

Eventos de Débito:

Id Evento Descrição
2 Debit Lançamento de débito das parcelas de uma transação.
4 FeeDebit Lançamento de débito da tarifa fixa acordada entre o Marketplace e a Braspag (Facilitador).
6 RefundDebit Lançamento de débito devido a um cancelamento.
8 ChargebackDebit Lançamento de débito devido a um chargeback.
10 UndoChargebackDebit Lançamento de débito para reversão de um chargeback.
12 AntiFraudFeeDebit Lançamento de débito referente à transação de antifraude.
14 AntiFraudFeeWithReviewDebit Lançamento de débito referente à transação de antifraude com revisão manual.
16 AdjustmentDebit Lançamento de um débito como ajuste.
18 ChargebackReversalDebit Lançamento de débito referente à reversão de um chargeback.
22 AnticipationCommissionDebit Lançamento de débito referente à comissão de uma antecipação.

Um evento poderá estar em um dos seguintes status na agenda financeira:

Consultar Eventos

A API Split permite consultar o que uma loja tem a receber dentro de um intervalo de datas, de acordo com o seguinte padrão de requisição:

Parâmetro Descrição Tipo Formato Obrigatório Valor Padrão
InitialForecastedDate Data de pagamento prevista inicial a ser consultada. Data YYYY-MM-DD Não CurrentDate
FinalForecastedDate Data de pagamento prevista final a ser consultada. Data YYYY-MM-DD Não InitialForecastedDate
InitialPaymentDate Data de pagamento inicial a ser consultada. Data YYYY-MM-DD Não -
FinalPaymentDate Data de pagamento final a ser consultada. Data YYYY-MM-DD Não InitialPaymentDate
PageIndex Página a ser consultada. Inteiro - Não 1
PageSize Tamanho da página. Valores possíveis: 25, 50, 100. Inteiro - Não 25
EventStatus Status do evento [Scheduled - Pending - Settled - Error - WaitingForAdjustmentDebit - Anticipated]. String - Não Todos
IncludeAllSubordinates Inclui todos os subordinados na consulta. Boolean - Não false
MerchantIds Lojas a serem consideradas na consulta. Guid - Não -

Requisições

Por Data Prevista de Pagamento

Por Data de Pagamento

x-www-form-urlencoded
--header "Authorization: Bearer {access_token}"

Resposta

{
    "PageCount": 1,
    "PageSize": 25,
    "PageIndex": 1,
    "Schedules": [
        {
            "Id": "b579fafb-8271-4a1d-a657-00e5fd9b9f83",
            "PaymentId": "069ee5ef-ce7a-43ce-a9af-022f652e115a",
            "MerchantId": "ea4db25a-f981-4849-87ff-026897e006c6",
            "ForecastedDate": "2018-08-22",
            "Installments": 10,
            "InstallmentAmount": 9255,
            "InstallmentNumber": 6,
            "Event": 1,
            "EventDescription": "Credit",
            "EventStatus": "Settled",
            "SourceId": "e3efe82f-1eee-4c28-bb9f-8054fcd4ca3f",
            "Mdr": 3.2,
            "Commission": false
        },
        {
            "Id": "2f110f0d-82c9-4a1f-8df5-08203348d160",
            "PaymentId": "069ee5ef-ce7a-43ce-a9af-022f652e115a",
            "MerchantId": "ea4db25a-f981-4849-87ff-026897e006c6",
            "ForecastedDate": "2018-08-22",
            "Installments": 10,
            "InstallmentAmount": 9255,
            "InstallmentNumber": 9,
            "Event": 1,
            "EventDescription": "Credit",
            "EventStatus": "Settled",
            "SourceId": "e3efe82f-1eee-4c28-bb9f-8054fcd4ca3f",
            "Mdr": 3.2,
            "Commission": false
        },
        {
            "Id": "01d9b78f-b287-4376-a5e4-12d91cde1938",
            "PaymentId": "069ee5ef-ce7a-43ce-a9af-022f652e115a",
            "MerchantId": "ea4db25a-f981-4849-87ff-026897e006c6",
            "ForecastedDate": "2018-08-22",
            "Installments": 10,
            "InstallmentAmount": 9255,
            "InstallmentNumber": 2,
            "Event": 1,
            "EventDescription": "Credit",
            "EventStatus": "Settled",
            "SourceId": "e3efe82f-1eee-4c28-bb9f-8054fcd4ca3f",
            "Mdr": 3.2,
            "Commission": false
        },
        {
            "Id": "e30760d7-01e2-4b2b-9a43-2b252fcfbd84",
            "PaymentId": "069ee5ef-ce7a-43ce-a9af-022f652e115a",
            "MerchantId": "ea4db25a-f981-4849-87ff-026897e006c6",
            "ForecastedDate": "2018-08-22",
            "Installments": 10,
            "InstallmentAmount": 9262,
            "InstallmentNumber": 10,
            "Event": 1,
            "EventDescription": "Credit",
            "EventStatus": "Settled",
            "SourceId": "e3efe82f-1eee-4c28-bb9f-8054fcd4ca3f",
            "Mdr": 3.2,
            "Commission": false
        },
        {
            "Id": "90ea1e11-568f-49ee-bc3f-7ab2a225a1e1",
            "PaymentId": "069ee5ef-ce7a-43ce-a9af-022f652e115a",
            "MerchantId": "ea4db25a-f981-4849-87ff-026897e006c6",
            "ForecastedDate": "2018-08-22",
            "Installments": 10,
            "InstallmentAmount": 9255,
            "InstallmentNumber": 1,
            "Event": 1,
            "EventDescription": "Credit",
            "EventStatus": "Settled",
            "SourceId": "e3efe82f-1eee-4c28-bb9f-8054fcd4ca3f",
            "Mdr": 3.2,
            "Commission": false
        }
    ]
}
Propriedade Descrição Tipo Tamanho
Schedules[].Id Identificador do evento na agenda financeira. Guid 36
Schedules[].PaymentId Identificador da transação. Guid 36
Schedules[].MerchantId Identificador da loja. Guid 36
Schedules[].PaymentDate Data de liquidação. Retornada somente quando pagamento realizado (EventStatus = Settled). Data -
Schedules[].ForecastedDate Data de liquidação prevista. Data -
Schedules[].Installments Número de parcelas da transação. Inteiro -
Schedules[].InstallmentAmount Valor, em centavos, da parcela a liquidar. Inteiro -
Schedules[].InstallmentNumber Número da parcela a liquidar. Inteiro -
Schedules[].Event Identificador do evento. Inteiro -
Schedules[].EventDescription Descrição do evento. Consulte os tipos de eventos de débito e crédito. String -
Schedules[].EventStatus Status do evento [Scheduled - Pending - Settled - Error - WaitingForAdjustmentDebit]. String -

Consultar Transações

O Split de Pagamentos permite consultar a agenda financeira de várias transações ou de uma transação específica, de acordo com o seguinte padrão de requisição:

Parâmetro Descrição Tipo Formato Obrigatório Valor Padrão
InitialCaptureDate Data inicial a ser consultada, considerando a data de captura das transações. Data YYYY-MM-DD Não CurrentDate
FinalCaptureDate Data final a ser consultada, considerando a data de captura das transações. Data YYYY-MM-DD Não InitialCaptureDate
PageIndex Página a ser consultada. Inteiro - Não 1
PageSize Tamanho da página. Valores possíveis: 25, 50, 100. Inteiro - Não 25
EventStatus Status do evento [Scheduled - Pending - Settled - Error - Anticipated]. String - Não Todos
IncludeAllSubordinates Inclui todos os subordinados na consulta. Boolean - Não false
MerchantIds Lojas a serem consideradas na consulta. Guid - Não -

Nota: Para informar várias lojas na consulta, basta repetir o parâmetro “merchantIds”. Caso não seja informada nenhuma loja, será considerada a loja utilizada na autenticação à API Split.

Requisições

Para Várias Transações

x-www-form-urlencoded
--header "Authorization: Bearer {access_token}"  

Resposta

{
    "PageCount": 1,
    "PageSize": 25,
    "PageIndex": 1,
    "Transactions": [
        {
            "PaymentId": "24afaaaf-f2a1-40a5-bb25-f914fa623c4c",
            "CapturedDate": "2017-12-01",
            "Schedules": [
                {
                    "MerchantId": "2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
                    "ForecastedDate": "2017-12-21",
                    "Installments": 2,
                    "InstallmentAmount": 24357,
                    "InstallmentNumber": 1,
                    "Event": "Credit",
                    "EventDescription": "Credit",
                    "EventStatus": "Scheduled"
                },
                {
                    "MerchantId": "e4db3e1b-985f-4e33-80cf-a19d559f0f60",
                    "ForecastedDate": "2017-12-21",
                    "Installments": 2,
                    "InstallmentAmount": 1450,
                    "InstallmentNumber": 1,
                    "Event": "Credit",
                    "EventDescription": "Credit",
                    "EventStatus": "Scheduled"
                },
                {
                    "MerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
                    "ForecastedDate": "2017-12-21",
                    "Installments": 2,
                    "InstallmentAmount": 38480,
                    "InstallmentNumber": 1,
                    "Event": "Credit",
                    "EventDescription": "Credit",
                    "EventStatus": "Scheduled"
                },
                {
                    "MerchantId": "e4db3e1b-985f-4e33-80cf-a19d559f0f60",
                    "ForecastedDate": "2017-12-21",
                    "Installments": 2,
                    "InstallmentAmount": 5,
                    "InstallmentNumber": 1,
                    "Event": "FeeDebit",
                    "EventDescription": "FeeDebit",
                    "EventStatus": "Scheduled"
                },
            ]
        }
    ]
}
Propriedade Descrição Tipo Tamanho
Transactions[].PaymentId Identificador da transação. Guid 36
Transactions[].CaptureDate Data de captura da transação. Data -
Transactions[].Schedules[].MerchantId Identificador da loja. Guid 36
Transactions[].Schedules[].PaymentDate Data de liquidação. Retornada somente quando pagamento realizado (EventStatus = Settled). Data -
Transactions[].Schedules[].ForecastedDate Data de liquidação prevista. Data -
Transactions[].Schedules[].Installments Número de parcelas a liquidar. Inteiro -
Transactions[].Schedules[].InstallmentsAmount Valor, em centavos, da parcela a liquidar. Inteiro -
Transactions[].Schedules[].InstallmentNumber Número da parcela a liquidar. Inteiro -
Transactions[].Schedules[].Event Identificador do evento. Inteiro -
Transactions[].Schedules[].EventDescription Descrição do evento. Consulte os tipos de eventos de débito e crédito. String -
Transactions[].Schedules[].EventStatus Status do evento [Scheduled - Pending - Settled - Error - Anticipated]. String -

Para Uma Transação Específica

Para consultar a agenda de uma transação específica, basta informar o identificador da transação (PaymentId) na requisição.

x-www-form-urlencoded
--header "Authorization: Bearer {access_token}"
PARÂMETRO DESCRIÇÃO TIPO TAMANHO
PaymentId Identificador da transação. Guid 36

Resposta

{
    "PageCount": 1,
    "PageSize": 25,
    "PageIndex": 1,
    "Transactions": [
        {
            "PaymentId": "cd2309d3-3fec-4816-aec7-bcb6d51a0988",
            "CapturedDate": "2017-12-11",
            "Schedules": [
                {
                    "MerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
                    "ForecastedDate": "2018-01-11",
                    "Installments": 1,
                    "InstallmentAmount": 5790,
                    "InstallmentNumber": 1,
                    "Event": 1,
                    "EventDescription": "Credit",
                    "EventStatus": "Scheduled"
                },
                {
                    "MerchantId": "2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
                    "ForecastedDate": "2018-01-11",
                    "Installments": 1,
                    "InstallmentAmount": 3790,
                    "InstallmentNumber": 1,
                    "Event": 1,
                    "EventDescription": "Credit",
                    "EventStatus": "Scheduled"
                }
            ]
        }
    ]
}

Anexos

Lista de HTTP Status Code

HTTP Status Code Descrição
200 OK
400 Bad Request
404 Resource Not Found
500 Internal Server Error