Operações

A API de Credenciamento é composta por 5 operações:

1 - Affiliate

É a principal operação. Ela é responsável pelo credenciamento de estabelecimentos comerciais na Stone.
É nessa operação que é configurado os dados de estabelecimento, do projeto e do parceiro que está credenciando.

Abaixo estão os parâmetros para cada configuração:

Configuração

Dados

Configurações do estabelecimento

CompanyName
TradeName
DocumentNumber
DocumentType
Mcc
BanckAccountList
MerchantAddressList
MerchantContactList
AccountEmailMerchantPartnerList
MerchantExtraDataList
MerchantWorkScheduleList

Configurações do projeto

MerchantCaptureMethodList
CardBrandList
MdrNegotiationList
ChainTypeIdList
ParentChainList
MerchantFraudToolList
PrepaymentConfiguration

Configurações do parceiro

SalesChannelId
SalesPartnerId
SalesTeamMemberId

2 - List Merchants

Essa operação lista as lojas credenciadas pelo parceiro com seus respectivos dados. Nesta operação você envia uma query com os dados que deseja pesquisa e como eles devem ser retornados (ordenação dos dados).

Para essa operação, os possíveis campos para busca são:

  • StoneCode;
  • AffiliationKey;
  • CompanyName;.
  • TradeName;
  • DocumentNumber;
  • MerchantStatus;
  • SalesChannelId;
  • SalesPartnerId;
  • SalesTeamMemberId;
  • Mcc;
  • SaleAffiliationKey;
  • CreationDate.

3 - List Terminal Devices

É a operação responsável por listar os terminais de um estabelecimento com seus respectivos dados. Nesta operação você envia uma query com os dados que deseja pesquisar e como eles devem ser retornados (ordenação dos dados).

Os possíveis campos para busca são:

  • StoneCode;
  • TerminalModelId;
  • StatusId;
  • SerialNumber.

4 - Add Rent Collection

Operação que lança cobranças de aluguel de meios de captura diretamente na agenda do lojista. Devem ser enviados os dados de data da cobrança, valor do aluguel e os dados do terminal (número de série e modelo).

5 - List Rent Collection

Operação responsável por listar cobranças de aluguel de meios de captura. Por ela você envia um objeto com os critérios da pesquisa.

Os possíveis campos para busca são:

  • StoneCode;
  • Data efetiva da cobrança.