Conexões
Vínculo entre a conta digital de um cliente e um ERP parceiro.
- GET/v1/connections · Listar conexões do parceiro
- POST/v1/connections · Iniciar conexão com a conta de um cliente
- GET/v1/connections/{connection_id} · Consultar conexão
- DELETE/v1/connections/{connection_id} · Encerrar conexão
Listar conexões do parceiro
GET/v1/connections
Parâmetros
- statuspending | awaiting_account | awaiting_enablement | active | revoked | expired · consulta
- —
- documentstring · consulta
CNPJ ou CPF, só dígitos.
- limitinteger · consulta
- —
- starting_afterstring · consulta
Id do último item da página anterior.
Resposta
- has_moreobrigatórioboolean
- —
- datalista de object
- —
- data[].idobrigatóriostring
- —
- data[].livemodeobrigatórioboolean
- —
- data[].statusobrigatóriopending | awaiting_account | awaiting_enablement | active | revoked | expired
pending: aguardando o dono da conta autorizar.awaiting_account: o cliente ainda está abrindo a conta digital.awaiting_enablement: autorizado, mas a conta ainda não tem as capacidades exigidas (vermissing_requirements).active: pronto para cobrar.revoked: encerrada por uma das partes.expired: aconnect_urlvenceu sem uso.- data[].documentobrigatóriostring
CPF (11 dígitos) ou CNPJ (14 dígitos), só números.
- data[].account_idstring ou nulo
Preenchido quando a conta digital é identificada.
- data[].scopesobrigatóriolista de charges:write | charges:read | payment_links:write | refunds:write | account:read
- —
- data[].connect_urlstring ou nulo
Link de autorização, devolvido só na criação. Vale 7 dias. O dono da conta recebe um código no contato cadastrado na conta digital para confirmar. Para um link novo, crie outra conexão: o convite anterior ainda não usado é substituído.
- data[].connect_url_expires_atstring ou nulo
- —
- data[].missing_requirementslista de account_approval | online_sales | pix | boleto | payment_link
O que falta na conta para a conexão ficar ativa.
- data[].external_referencestring ou nulo
- —
- data[].created_atobrigatóriostring
- —
- data[].activated_atstring ou nulo
- —
- data[].revoked_atstring ou nulo
- —
Códigos de resposta
- 200 Página de conexões.
- 401 Chave ausente, inválida ou revogada.
Iniciar conexão com a conta de um cliente
POST/v1/connections
Só para chaves de parceiro. Gera uma connect_url que o dono da conta abre para autorizar o ERP. Se o CNPJ ou CPF ainda não tiver conta digital, a mesma URL leva à abertura em conta.mcpfpay.com.br e retoma a autorização quando a conta for aprovada. O resultado chega pelo evento connection.active.
Parâmetros
- Idempotency-Keystring · cabeçalho
Até 255 caracteres. Mesma chave em 24 horas devolve a mesma resposta.
Corpo da requisição (JSON)
- documentobrigatóriostring
CPF (11 dígitos) ou CNPJ (14 dígitos), só números.
- scopesobrigatóriolista de charges:write | charges:read | payment_links:write | refunds:write | account:read
- —
- external_referencestring
Id do cliente no seu ERP.
- notifyobject
Se informado, o gateway envia a
connect_urlao cliente.- notify.emailstring
- —
- notify.whatsappstring
- —
- return_urlstring
Para onde o cliente volta depois de autorizar.
Resposta
- idobrigatóriostring
- —
- livemodeobrigatórioboolean
- —
- statusobrigatóriopending | awaiting_account | awaiting_enablement | active | revoked | expired
pending: aguardando o dono da conta autorizar.awaiting_account: o cliente ainda está abrindo a conta digital.awaiting_enablement: autorizado, mas a conta ainda não tem as capacidades exigidas (vermissing_requirements).active: pronto para cobrar.revoked: encerrada por uma das partes.expired: aconnect_urlvenceu sem uso.- documentobrigatóriostring
CPF (11 dígitos) ou CNPJ (14 dígitos), só números.
- account_idstring ou nulo
Preenchido quando a conta digital é identificada.
- scopesobrigatóriolista de charges:write | charges:read | payment_links:write | refunds:write | account:read
- —
- connect_urlstring ou nulo
Link de autorização, devolvido só na criação. Vale 7 dias. O dono da conta recebe um código no contato cadastrado na conta digital para confirmar. Para um link novo, crie outra conexão: o convite anterior ainda não usado é substituído.
- connect_url_expires_atstring ou nulo
- —
- missing_requirementslista de account_approval | online_sales | pix | boleto | payment_link
O que falta na conta para a conexão ficar ativa.
- external_referencestring ou nulo
- —
- created_atobrigatóriostring
- —
- activated_atstring ou nulo
- —
- revoked_atstring ou nulo
- —
Códigos de resposta
- 201 Conexão criada, aguardando o cliente.
- 400 Parâmetro ausente ou inválido.
- 401 Chave ausente, inválida ou revogada.
- 403 Sem conexão ativa com a conta, escopo insuficiente ou conta sem a capacidade exigida.
- 409 Estado não permite a operação, ou `Idempotency-Key` reutilizada com outro corpo.
Consultar conexão
GET/v1/connections/{connection_id}
Resposta
- idobrigatóriostring
- —
- livemodeobrigatórioboolean
- —
- statusobrigatóriopending | awaiting_account | awaiting_enablement | active | revoked | expired
pending: aguardando o dono da conta autorizar.awaiting_account: o cliente ainda está abrindo a conta digital.awaiting_enablement: autorizado, mas a conta ainda não tem as capacidades exigidas (vermissing_requirements).active: pronto para cobrar.revoked: encerrada por uma das partes.expired: aconnect_urlvenceu sem uso.- documentobrigatóriostring
CPF (11 dígitos) ou CNPJ (14 dígitos), só números.
- account_idstring ou nulo
Preenchido quando a conta digital é identificada.
- scopesobrigatóriolista de charges:write | charges:read | payment_links:write | refunds:write | account:read
- —
- connect_urlstring ou nulo
Link de autorização, devolvido só na criação. Vale 7 dias. O dono da conta recebe um código no contato cadastrado na conta digital para confirmar. Para um link novo, crie outra conexão: o convite anterior ainda não usado é substituído.
- connect_url_expires_atstring ou nulo
- —
- missing_requirementslista de account_approval | online_sales | pix | boleto | payment_link
O que falta na conta para a conexão ficar ativa.
- external_referencestring ou nulo
- —
- created_atobrigatóriostring
- —
- activated_atstring ou nulo
- —
- revoked_atstring ou nulo
- —
Códigos de resposta
- 200 Conexão.
- 404 Recurso não encontrado para esta chave.
Encerrar conexão
DELETE/v1/connections/{connection_id}
O parceiro deixa de operar a conta. Cobranças já emitidas continuam válidas.
Resposta
- idobrigatóriostring
- —
- livemodeobrigatórioboolean
- —
- statusobrigatóriopending | awaiting_account | awaiting_enablement | active | revoked | expired
pending: aguardando o dono da conta autorizar.awaiting_account: o cliente ainda está abrindo a conta digital.awaiting_enablement: autorizado, mas a conta ainda não tem as capacidades exigidas (vermissing_requirements).active: pronto para cobrar.revoked: encerrada por uma das partes.expired: aconnect_urlvenceu sem uso.- documentobrigatóriostring
CPF (11 dígitos) ou CNPJ (14 dígitos), só números.
- account_idstring ou nulo
Preenchido quando a conta digital é identificada.
- scopesobrigatóriolista de charges:write | charges:read | payment_links:write | refunds:write | account:read
- —
- connect_urlstring ou nulo
Link de autorização, devolvido só na criação. Vale 7 dias. O dono da conta recebe um código no contato cadastrado na conta digital para confirmar. Para um link novo, crie outra conexão: o convite anterior ainda não usado é substituído.
- connect_url_expires_atstring ou nulo
- —
- missing_requirementslista de account_approval | online_sales | pix | boleto | payment_link
O que falta na conta para a conexão ficar ativa.
- external_referencestring ou nulo
- —
- created_atobrigatóriostring
- —
- activated_atstring ou nulo
- —
- revoked_atstring ou nulo
- —
Códigos de resposta
- 200 Conexão revogada.
- 404 Recurso não encontrado para esta chave.