Overview
API baseada em RESTful
Requisições no padrão JSON
Endpoints organizados por contexto de negócio
Versionamento implícito via ambiente (stage, prod)
Tratamento padrão de erros HTTP
Integração com OAuth2 (/oauth) para autenticação
🚦 Nomenclaturas
Seller/Vendedor
Nome da empresa ou pessoa física com conta na GOPAG
Buyer/Comprador
Nome do cliente final (pessoa que está pagando para um seller)
Business Unit
Nome da unidade interna na API, atrelada a um seller
User
Usuário atrelado a uma unidade/seller
🔐 Ambientes, autenticação e Segurança
🌐 URLs Base
Ambiente de produção: https://app.gopag.com.br
Ambiente de homologação/stage : https://app-stage.gopag.com.br
🔐 Token de API
Obtenha o token de autenticação pelo portal GoPag.
Todas as requisições à API devem incluir o seguinte cabeçalho HTTP:
Authorization: Bearer <seu_token_aqui>Substitua <seu_token_aqui> pelo token obtido no portal. Esse token é obrigatório para autenticação e autorização de chamadas à API, tanto em ambiente de produção quanto em homologação (stage).
Certifique-se também de enviar as requisições com o cabeçalho:
Content-Type: application/json📦 Códigos de retorno
Error Constants and Messages
BUYER_CREATED_SUCCESS
Comprador criado com sucesso
Buyer created with success
BUYER_UPDATED_SUCCESS_1
Comprador atualizado com sucesso
Buyer updated successfully
BUYER_UPDATED_SUCCESS_2
Comprador já estava atualizado
Buyer already up to date
BUYER_FAIL_ADD_OR_UPDATE_1
Falha ao adicionar ou atualizar comprador [1]
Fail to add or update buyer [1]
BUYER_FAIL_ADD_OR_UPDATE_3
Falha ao adicionar ou atualizar comprador [3]
Fail to add or update buyer [3]
BUYER_FETCH_SUCCESS
Dados da comprador obtidos com sucesso
Buyer data fetched successfully
BUYER_FORBIDDEN
Acesso negado ao comprador
Buyer access denied
BUYER_TAXPAYER_ID_NOT_FOUND
CPF/CNPJ não encontrado
TaxpayerId not found
INVOICY_CREATED
Cobrança criada com sucesso
Invoicy created successfully
INVOICY_DELETED
Cobrança deletada com sucesso
Invoicy deleted successfully
INVOICY_UPDATED
Cobrança atualizada com sucesso
Invoicy updated successfully
INVOICY_FAIL_ADD_BUYER
Falha ao adicionar comprador
Fail to pay invoicy, failed to add buyer
INVOICY_FAIL_ADD_BUYER_MISMATCH
Falha ao adicionar comprador: dados inconsistentes
Fail to pay invoicy, failed to add buyer due to data mismatch
INVOICY_FAIL_NOTIFY
Falha ao enviar notificação
Failed to send notification
INVOICY_FAIL_DELETE
Falha ao deletar cobrança
Failed to delete invoicy
INVOICY_FAIL_TOKENIZATION
Falha ao tokenizar cartão de crédito
Failed to tokenize credit card
INVOICY_FAIL_UNKNOWN
Erro desconhecido na cobrança
Unknown error while on invoicy
INVOICY_FAILED_FROM_SOURCE
Falha ao gerar cobrança a partir da origem
Failed to generate invoicy from source
INVOICY_FETCH_ERROR
Falha ao obter os dados da cobrança
Failed to fetch invoicy data
INVOICY_FETCH_SUCCESS
Dados da cobrança obtidos com sucesso
Invoicy data fetched successfully
INVOICY_FORBIDDEN
Acesso negado à cobrança
Invoicy access denied
INVOICY_GENERATED_FROM_SOURCE
Cobrança gerada a partir da origem com sucesso
Invoicy successfully generated from source
INVOICY_INSTALLMENT_PLAN_INVALID
Plano de parcelamento inválido para este tipo de pagamento
Invalid installment plan for selected payment type
INVOICY_INVALID_FIELD_3DS
Campo obrigatório do 3D Secure está ausente ou inválido
Required 3D Secure field is missing or invalid
INVOICY_INVALID_FIELD_CREDIT_CARD
Campo obrigatório do cartão de crédito está ausente ou inválido
Required credit card field is missing or invalid
INVOICY_INVALID_TYPE
Tipo de cobrança inválido
Invalid invoicy type
INVOICY_NOT_FOUND
Cobrança não encontrada
Invoicy not found
INVOICY_NOTHING_TO_RUN_NEXT_DATE
Nada a processar: data da próxima execução não chegou
Nothing to run: next execution date has not arrived
INVOICY_NOTHING_TO_RUN_NEXT_RETRY_DATE
Nada a processar: data da próxima tentativa execução não chegou
Nothing to run: next retry execution date has not arrived
INVOICY_NOTHING_TO_RUN_PAYMENT_TYPE
Nada a processar: tipo de pagamento vazio
Nothing to run: empty payment type
INVOICY_NOTHING_TO_RUN_STATUS
Nada a processar: status inválido para execução
Nothing to run: status not eligible for execution
INVOICY_PAYMENT_TYPE_MISMATCH
Tipo de pagamento diferente do selecionado anteriormente
Selected payment type does not match previously selected
INVOICY_PAYMENT_TYPE_UNAVAILABLE
Tipo de pagamento indisponível
Selected payment type is unavailable
INVOICY_RECURRENCE_PROCESSED
Cobrança de recorrência processada com sucesso
Recurrence invoicy processed successfully
INVOICY_RECURRENCE_PROCESSED_WITH_ERRORS
Cobrança de recorrência processada com erros
Recurrence invoicy processed with errors
INVOICY_RECURRENCE_UPDATED
Cobrança de recorrência atualizada com sucesso
Recurrence updated successfully
INVOICY_STATUS_INVALID
Status atual não permite pagamento
Current status does not allow payment
INVOICY_SUCCESS_NOTIFY
Notificação enviada com sucesso
Notification sent successfully
INVOICY_EXCEED_ATTEMPTS_TOKENIZED_CREDIT_CARD
Cartão de crédito tokenizado na cobrança bloqueado
Tokenized credit card blocked for invoicy
INVOICY_EXCEED_ATTEMPTS_RECURRENCE
Cobrança recorrente excedeu as tentativas
Invoicy recurrence exceeded attempts
INVOICY_TOKENIZE_INVALID_CUSTOMER
Cliente retornado na tokenização é inválido
Returned customer on tokenization is invalid
INVOICY_TOKENIZE_INVALID_RESPONSE
Resposta inválida ao tentar tokenizar o cartão
Invalid response while tokenizing card
Last updated