Iniciação de Pagamento GPS

Inicie um pagamento de GPS através desta API. Assim como outras operações de saída de dinheiro, os pagamento iniciados por API devem ser aprovados no aplicativo.

154
Importante para Integração Direta Para você conseguir efetuar essa integração é obrigatória a leitura sobre "Utilização das APIs" e recomendada a leitura sobre "Instruções Iniciais" e "Client Credentials e Client ID"

Quais são os requisitos para a utilização desta API?

  • Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
  • GPS: é necessário ter informações essenciais, como o código da receita e competência. Essas informações, entre outras descritas abaixo, são necessárias para que a API possa processar e validar a transação de forma correta e eficiente. Além disso, é importante garantir que as informações inseridas estejam corretas para evitar erros ou atrasos no processo de pagamento.
  • Escopo: para a modalidade Parceria Cora, é necessário ter ativado o escopo correto ao solicitar autorização e gerar token de acesso para que sua aplicação possa acessar e interagir com as informações da conta de forma segura e autorizada. É possível consultar mais detalhes sobre o escopo e autorização no tópico Redirecionamento.
Nome do escopoDescrição
paymentAPIs de iniciação de pagamento

Bora pro código?

383

Parâmetros da requisição

ParâmetroTipoDescrição
code
opcional
StringCódigo definido por você, pode ser um id do recurso no seu sistema. Nós iremos retornar esse código sempre que você consultar uma fatura.
data
obrigatório
Objeto DataObjeto Data

Objeto Data

ParâmetroTipoDescrição
name
obrigatório
StringNome completo.
code
obrigatório
StringCódigo da receita. Aceita 4 ou 5 dígitos.
identity
obrigatório
StringNúmero do CPF ou CNPJ.
identification_type
obrigatório
StringTipo de Contribuinte. Objeto PaymentGPSIdentification
competence
obrigatório
StringCompetência. O formato é somente aaaa-mm. Ex: 2022-12
scheduled_at
opcional
StringCampo para agendar um pagamento. Ex: "2023-05-30"
amount
obrigatório
Objeto GPSAmountObjeto GPSAmount

Objeto PaymentGPSIdentification

CódigoDescrição
NITNúmero de registro do trabalhador. Apenas para trabalhadores autônomos.
PASEPPrograma de Formação do Patrimônio do Servidor Público. Apenas para servidores públicos.
PISPrograma de integração Social. Para demais trabalhadores.

Objeto GPSAmount

ParâmetroTipoDescrição
other_entity
obrigatório
IntValor de outras entidades.
inss
obrigatório
IntValor do INSS a ser pago.
charge
obrigatório
IntValor somado dos juros e multa.

Parâmetros da resposta

ParâmetroTipoDescrição
code
opcional
StringCódigo definido por você, pode ser um id do recurso no seu sistema. Nós iremos retornar esse código sempre que você consultar uma fatura.
data
obrigatório
Objeto DataObjeto Data

Objeto Data

ParâmetroTipoDescrição
id
obrigatório
StringID do pagamento iniciado.
status
obrigatório
StringObjeto PaymentStatus
amount
obrigatório
IntValor do pagamento em centavos.
services
obrigatório
Objeto ServicesLista Objeto Services
payment_terms
obrigatório
Objeto Payment_termsObjeto PaymentTerms
created_at
obrigatório
StringDia da criação da iniciação de pagamento. Ex: "2023-04-30T13:58:21".
scheduled_at
obrigatório
StringDia que o pagamento foi agendado. Ex: "2023-05-30".

Objeto Services

ParâmetroTipoDescrição
name
obrigatório
String
description
obrigatório
String
amount
obrigatório
IntValor do pagamento em centavos.

Objeto Payment_terms

ParâmetroTipoDescrição
due_date
obrigatório
StringData de Vencimento da DARF Ex: "2023-05-30"
available_date
obrigatório
StringValor nulo.

Integração Direta e Testes

Esta plataforma de documentação, atualmente, não permite o upload de informações importantes como certificados e private keys. Por isso, não recomendamos o uso dela para testes da modalidade de Integração Direta.

Para fazer os testes que incluam essas informações sensíveis pedimos que use um sistema de sua escolha.
Caneca na cor rosa com a logo da Cora e com forma geométrica
Agora é hora do Café! Sim, aprendemos a iniciar um pagamento de GPS
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!