Introdução
O objetivo desta documentação é orientar o desenvolvedor sobre como integrar sua plataforma à API do Split de Pagamentos, descrevendo os serviços disponíveis com exemplos de requisição e resposta.
O Split de Pagamentos se divide em Transacional e Agenda Financeira / Conciliação.
Transacional
As operações transacionais serão responsáveis pela criação de novas transações e manipulação, permitindo que sejam capturas, canceladas ou estornadas de acordo com seus prazos.
Possuímos duas maneiras de integração com as API transacionais, são elas:
Agenda Financeira / Conciliação
As operações de gerenciamento do Split de Pagamentos serão exploradas nessa documentação. Elas lhe permitem acessar serviços como:
- Agenda Financeira
- Chargeback (Divisão)
- Liquidação (Trava)
- Antecipação (Liberação)
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:
- Combine a base da URL do ambiente com o endpoint da operação desejada. Ex.: https://split.braspag.com.br/oauth2/token.
- 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. |
Nota: Solicite suas credenciais para o ambiente de teste em nosso Portal de Suporte ou pelo telefone 3003-6554.
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:
- Concatene o ClientId e ClientSecret:
ClientId:ClientSecret
. - Codifique o resultado da concatenação em Base64.
- 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
}
Nota: O ClientId é o identificador dentro da Braspag, conhecido também como MerchantId. O ClientSecret é a chave utilizada na autenticação.
O token retornado (access_token
) deverá ser utilizado em toda requisição à API Split como uma chave de autorização. O mesmo possui uma validade de 20 minutos, sendo necessário obter um novo token toda vez que ele 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:
- Scheduled: Agendado.
- Pending: Aguardando confirmação de liquidação.
- Settled: Liquidado.
- Error: Erro de liquidação na instituição financeira.
- WaitingForAdjustmentDebit: Aguardando liquidação do ajuste de débito associado.
- Anticipated: Evento antecipado.
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.
Neste caso, poderão ser utilizados os filtros MerchantIds
e EventStatus
.
x-www-form-urlencoded
--header "Authorization: Bearer {access_token}"
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"
}
]
}
]
}
Ajustes
O Split de Pagamentos permite que sejam lançados ajustes a crédito e a débito nas agendas dos Subordinados.
Um ajuste somente será efetivamente liquidado para os envolvidos caso o participante a ser debitado possua saldo positivo na data prevista informada para efetivação do ajuste. Caso contrário, a liquidação do ajuste será postergada, para ambos os envolvidos, até que o participante a ser debitado tenha saldo positivo para cobrir o valor do ajuste.
Ex: Marketplace lança um ajuste a débito de R$100,00 para o Subordinado “A” com data prevista de cobrança em 17/10/2018.
Caso 1) Subordinado possui saldo positivo na data prevista informada.
Os valores até o dia 16/10/2018 foram liquidados normalmente.
Como o subordinado tinha R$150,00 para receber no dia 17/10/2018, o ajuste foi lançado na agenda financeira na data prevista informada e o mesmo receberá R$50,00 devido ao débito do ajuste.
O participante a ser creditado terá a efetivação do crédito na mesma data de efetivação do débito, ou seja, receberá R$150,00 no dia 17/10/2018.
Caso 2) Subordinado não possui saldo positivo na data prevista informada.
Os valores até o dia 16/10/2018 foram liquidados normalmente.
O Subordinado tinha a receber apenas R$60,00 no dia 17/10/2018, o que não cobre o valore do ajuste a ser debitado do mesmo.
Neste cenário, os pagamentos do subordinado serão retidos até que o mesmo tenha saldo para cobrir o ajuste, o que ocorre no dia 19/10/2018, onde o acumulado retido é de R$130,00. Com isso, o subordinado receberá R$30,00.
O participante a ser creditado terá a efetivação do crédito na mesma data de efetivação do débito, ou seja, receberá R$150,00 no dia 19/10/2018.
Criar Ajuste
A criação de um novo ajuste na agenda financeira deve ser realizado como no exemplo abaixo:
Requisição
--header "Authorization: Bearer {access_token}"
--header "Accept: application/json"
{
"merchantIdToDebit": "EA4DB25A-F981-4849-87FF-026897E006C6",
"merchantIdToCredit": "44F68284-27CF-43CB-9D14-1B1EE3F36838",
"forecastedDate": "2018-09-17",
"amount": 1000,
"description": "Multa por não cumprimento do prazo de entrega no pedido XYZ",
"transactionId": "717A0BD0-3D92-43DB-9D1E-9B82DFAFA392"
}
Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
---|---|---|---|---|
merchantIdToDebit |
Merchant do qual o valor será debitado. | GUID | - | Sim |
merchantIdToCredit |
Merchant para o qual o valor será creditado. | GUID | - | Sim |
forecastedDate |
Data prevista para lançamento do ajuste na agenda financeira. | String | - | Sim |
amount |
Valor em centavos do ajuste. | Inteiro | - | Sim |
description |
Descrição do ajuste. | String | 500 | Sim |
transactionId |
Identificador da transação para qual o ajuste está sendo lançado. | Guid | - | Não |
Resposta
-- 201 - Created
{
"id": "68465ddd-451a-4194-abca-be1ed71fb2ea",
"merchantIdToDebit": "EA4DB25A-F981-4849-87FF-026897E006C6",
"merchantIdToCredit": "44F68284-27CF-43CB-9D14-1B1EE3F36838",
"forecastedDate": "2018-09-19",
"amount": 1000,
"description": "Multa por não cumprimento do prazo de entrega no pedido",
"transactionId": "717A0BD0-3D92-43DB-9D1E-9B82DFAFA392",
"status": "Created"
}
Propriedade | Descrição | Tipo | Tamanho | Obrigatório |
---|---|---|---|---|
id |
Identificador do ajuste. | Guid | 36 | - |
status |
Status do ajuste [Created - Scheduled - Processed - Cancelled ]. | String | - | - |
Consulta de Ajustes
É possível realizar consulta de ajustes com base em um período.
Requisição
x-www-form-urlencoded
--header "Authorization: Bearer {access_token}"
Parâmetro | Descrição | Tipo | Tamanho | Obrigatório |
---|---|---|---|---|
Status |
Status do ajuste [Created, Scheduled, Processed, Cancelled]. | String | - | Sim |
InitialCreationDate |
Data de criação do ajuste. | YYYY-MM-DD | - | Sim |
Page |
Índice da página. | Inteiro | - | Não |
PageSize |
Quantidade total de itens por página. | Inteiro | - | Não |
Resposta
-- 200 - OK
{
"pagination": {
"total": 1,
"pageSize": 25,
"currentPage": 1,
"pageCount": 1,
"lastPage": true
},
"items": [
{
"id": "61166084-eaa0-4b7f-9e48-0cf14653c872",
"createdAt": "2021-03-19 15:18:18",
"createdBy": "249c0073-94ac-4a1e-9931-8ca4efba8907",
"merchantIdToDebit": "249c0073-94ac-4a1e-9931-8ca4efba8907",
"merchantIdToCredit": "f5d3eeab-9fc8-4a6e-ba66-d676d5c1a5cb",
"forecastedDate": "2021-03-30",
"amount": 1000,
"transactionId": "fa6633aa-ee0f-4b14-a558-0e15f2df2388",
"description": "Bonificação",
"status": "Created"
}
]
}
Propriedade | Descrição | Tipo | Tamanho | Formato |
---|---|---|---|---|
Pagination.Total |
Total de páginas. | Inteiro | - | Número |
Pagination.PageSize |
Quantidade total de itens por página. | Inteiro | - | Número |
Pagination.CurrentPage |
Página atual. | Inteiro | - | Número |
Pagination.PageCount |
Quantidade de itens na página atual. | Inteiro | - | Número |
Pagination.LastPage |
Última página. | Booleano | - | true ou false |
Items[].Id |
Id do ajuste. | GUID | - | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
Items[].CreatedAt |
Data de criação. | String | - | yyyy-MM-dd hh:mm:ss |
Items[].MerchantIdToDebit |
Merchant do qual o valor será debitado. | GUID | - | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
Items[].MerchantIdToCredit |
Merchant para o qual o valor será creditado. | GUID | - | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
Items[].ForecastedDate |
Data de previsão. | String | - | yyyy-MM-dd |
Items[].Amount |
Valor do ajuste em centavos. | Inteiro | - | Número |
Items[].TransactionId |
Id da transação. | GUID | - | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
Items[].Description |
Descrição do ajuste. | String | 500 | Texto alfanumérico |
Chargeback
No Split de Pagamentos, o Marketplace pode definir se assumirá o chargeback ou se o repassará para seus Subordinados, desde que acordado previamente entre as partes.
Se o Marketplace optar por repassar para os Subordinados, o Chargeback Total é sensibilizado automaticamente na agenda dos mesmos. Caso contrário, o chargeback será sensibilizado automaticamente na agenda do Marketplace, como acontece com um Chargeback Parcial.
O Marketplace pode decidir ainda repassar o chargeback para seus subordinados. Para isso, a API Split disponibiliza um serviço onde o Marketplace pode informar como dividir o valor do chargeback entre os subordinados, caso seja um Chargeback Parcial.
No exemplo abaixo, ocorreu um Chargeback Parcial no valor de R$60,00 de uma transação com valor capturado de R$100,00.
Requisição
[
{
"SubordinateMerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
"ChargebackAmount": 4000
},
{
"SubordinateMerchantId": "2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
"ChargebackAmount": 2000
}
]
Propriedade | Descrição | Tipo | Tamanho |
---|---|---|---|
SubordinateMerchantId |
Identificador do Subordinado. | Guid | 36 |
ChargebackAmount |
Valor do chargeback que deverá ser repassado ao Subordinado, em centavos. | Inteiro | - |
Resposta
{
"ChargebackSplitPayments": [
{
"SubordinateMerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
"ChargebackAmount": 4000,
"ChargebackSplits": [
{
"MerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
"ChargebackAmount": 3780
},
{
"MerchantId": "e4db3e1b-985f-4e33-80cf-a19d559f0f60",
"ChargebackAmount": 220
}
]
},
{
"SubordinateMerchantId": "2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
"ChargebackAmount": 2000,
"ChargebackSplits": [
{
"MerchantId": "2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
"ChargebackAmount": 1912
},
{
"MerchantId": "e4db3e1b-985f-4e33-80cf-a19d559f0f60",
"ChargebackAmount": 88
}
]
}
]
}
Propriedade | Descrição | Tipo | Tamanho |
---|---|---|---|
ChargebackSplitPayments.ChargebackSplits |
Lista contendo a divisão do chargeback para cada participante. | Guid | 36 |
Anexos
Lista de HTTP Status Code
HTTP Status Code | Descrição |
---|---|
200 | OK |
400 | Bad Request |
404 | Resource Not Found |
500 | Internal Server Error |