post https://api.stage.cora.com.br/payments/gps/initiate
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.
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 escopo | Descrição |
|---|---|
payment | APIs de iniciação de pagamento |
Parâmetros da requisição
| Parâmetro | Tipo | Descrição |
|---|---|---|
| code opcional | String | Có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 Data | Objeto Data |
Objeto Data
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name obrigatório | String | Nome completo. |
| code obrigatório | String | Código da receita. Aceita 4 ou 5 dígitos. |
| identity obrigatório | String | Número do CPF ou CNPJ. |
| identification_type obrigatório | String | Tipo de Contribuinte. Objeto PaymentGPSIdentification |
| competence obrigatório | String | Competência. O formato é somente aaaa-mm. Ex: 2022-12 |
| scheduled_at opcional | String | Campo para agendar um pagamento. Ex: "2023-05-30" |
| amount obrigatório | Objeto GPSAmount | Objeto GPSAmount |
Objeto PaymentGPSIdentification
| Código | Descrição |
|---|---|
NIT | Número de registro do trabalhador. Apenas para trabalhadores autônomos. |
PASEP | Programa de Formação do Patrimônio do Servidor Público. Apenas para servidores públicos. |
PIS | Programa de integração Social. Para demais trabalhadores. |
Objeto GPSAmount
| Parâmetro | Tipo | Descrição |
|---|---|---|
| other_entity obrigatório | Int | Valor de outras entidades. |
| inss obrigatório | Int | Valor do INSS a ser pago. |
| charge obrigatório | Int | Valor somado dos juros e multa. |
Parâmetros da resposta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| code opcional | String | Có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 Data | Objeto Data |
Objeto Data
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id obrigatório | String | ID do pagamento iniciado. |
| status obrigatório | String | Objeto PaymentStatus |
| amount obrigatório | Int | Valor do pagamento em centavos. |
| services obrigatório | Objeto Services | Lista Objeto Services |
| payment_terms obrigatório | Objeto Payment_terms | Objeto PaymentTerms |
| created_at obrigatório | String | Dia da criação da iniciação de pagamento. Ex: "2023-04-30T13:58:21". |
| scheduled_at obrigatório | String | Dia que o pagamento foi agendado. Ex: "2023-05-30". |
Objeto Services
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name obrigatório | String | |
| description obrigatório | String | |
| amount obrigatório | Int | Valor do pagamento em centavos. |
Objeto Payment_terms
| Parâmetro | Tipo | Descrição |
|---|---|---|
| due_date obrigatório | String | Data de Vencimento da DARF Ex: "2023-05-30" |
| available_date obrigatório | String | Valor 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.
Agora é hora do Café!
Sim, aprendemos a iniciar um pagamento de GPS