These docs are for v4. Click to read the latest docs for v5.

Retornando Efeitos de Contratos

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
CampoDescrição
KeyChave do contrato
contractHolderCredor (só o documento)
contractTypeTipo do contrato
PaymentSchemeArranjo de pagamento
totalAmountValor da UR
uncommittedAmountValor livre da UR
expectedSettlementDateData de vencimento
effectPriorityPrioridade do efeito de contrato
divisionMethodTipo do efeito (valor ou porcentagem)
effectAmountValor do efeito (0 a 100 se for porcentagem)
committedEffectAmountValor do efeito aplicado (esse que é somado por dia na tela “Agenda de contratos”)

❗️

Atenção: Essa versão de API será descontinuada

Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.

No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.

Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.

Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para [email protected] e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

Query Params
string
required
string
date
required
date
required
string
string
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json