Consultar Split da Transação

Recupera os dados de divisão de valores (split) associados a uma transação específica.

🔼
GET{urlServidor}/v1/marketplace/transactions/{id}/split

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Exemplo de header da requisição

curl--request GET \
--location '/v1/marketplace/transactions/123/split' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Parâmetros da Requisição

Headers

Nome	Tipo	Obrigatório	Descrição
`integration-key`	string	Sim	Chave de integração.
`x-token`	string	Sim	Token de autenticação. Pode ser encontrado em nosso portal na guia de integração.
`Authorization`	Auth Type Bearer Token	Sim	Inserir o Bearer Token, gerado na rota Auth

Parâmetros de Path

Nome	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da transação a ser consultada.

Modelo Resposta

📦 Estrutura da Resposta – Consultar Split de Transação

Nome	Tipo	Obrigatório	Descrição
`_id`	string	Sim	Identificador único do split gerado.
`transaction_id`	string	Sim	Identificador da transação à qual o split está vinculado.
`status`	string	Sim	Status atual do split. Valores possíveis: `PENDING`, `ACTIVE`, `CANCELED`.
`establishment.id`	number	Sim	ID do estabelecimento principal.
`establishment.first_name`	string	Sim	Nome completo ou razão social do estabelecimento principal.
`establishment.last_name`	string	Não	Nome fantasia do estabelecimento principal.
`establishment.document`	string	Sim	CPF ou CNPJ do estabelecimento principal.
`title`	string	Não	Título informativo do split (caso utilizado).
`original_amount`	number	Sim	Valor bruto disponível para divisão, já descontado o custo de antifraude (em centavos).
`channel`	string	Sim	Canal da transação. Valores possíveis: `CHIP`, `TAP`, `SMART`, `ONLINE`, `ALL`.
`modality`	string	Sim	Modalidade de pagamento. Valores possíveis: `DEBIT`, `PIX`, `CREDIT`, `ALL`.
`division`	string	Sim	Regra de divisão aplicada. Valores possíveis: `PERCENTAGE` (percentual) ou `CURRENCY` (valor fixo).

🏢 Array establishments – Estabelecimentos participantes do split

Nome	Tipo	Obrigatório	Descrição
`id`	number	Sim	ID do estabelecimento participante.
`first_name`	string	Sim	Nome completo ou razão social.
`last_name`	string	Não	Nome fantasia.
`document`	string	Sim	CPF ou CNPJ do estabelecimento.
`priority`	number	Sim	Ordem de prioridade de execução na divisão.
`value`	number	Sim	Valor definido para o split. Pode representar centavos ou percentual, dependendo da `division`.
`original_amount`	number	Sim	Valor total repassado ao estabelecimento, calculado em centavos.
`transaction_id`	string	Sim	ID da transação originada para o repasse.

📘 Array history[] – Histórico de status do split

Nome	Tipo	Obrigatório	Descrição
`created_at`	string (date)	Sim	Data/hora do evento no histórico.
`status`	string	Sim	Status do split naquele momento (`PENDING`, `ACTIVE`, `CANCELED`).
`message`	string	Não	Mensagem informativa associada à alteração de status.

🕒 Campo created_at

Nome	Tipo	Obrigatório	Descrição
`created_at`	string (date)	Sim	Data de criação do split no formato ISO 8601.

Para mais informações, consulte a documentação oficial da Paytime.

Códigos de Resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.

Updated 6 months ago

Did this page help you?