Criar novo pagamento

POSThttps://api.sandbox.cefispay.com.br/api/v1/payments

RECIPES

Realiza uma cobrança via cartão de crédito, boleto bancário ou PIX. Nota: Pagamentos com cartão devem incluir um hash de cartão (se você ainda não sabe como obter um, consulte a sessão Hash de cartões) ou os dados do cartão. Dê sempre preferência ao método de hash por ser uma alternativa mais segura. Cartão de crédito: o cliente do pagamento (informado em customer ou já cadastrado) precisa ter CPF ou CNPJ, telefone, CEP e número do endereço. Esses dados são enviados à adquirente como dados do titular, e a cobrança é recusada se algum deles estiver faltando. Recomendamos cadastrar o cliente com o máximo de informações possível, mesmo que hoje você só cobre por boleto ou Pix.

Parâmetros do body

obrigatórioapplication/json

Descreve os dados a serem incluídos no corpo da requisição. Atenção: alguns dados deixam de ser e tornam obrigatórios de acordo com outros dados enviados juntos com a requisição. Leia atentamente a descrição de todos os campos.

methodstringobrigatório
O método que será usado para este pagamento. Posteriormente, caso necessário, este pagamento pode ser pago com outros métodos.
Valores permitidos:creditbilletpix
valuestring
O valor do pagamento em centavos. Por exemplo, para R$50,00, o value deve ser 5000. Obrigatório se os items não forem informados. Se os items forem especificado para o pagamento, a soma do valor dos items será usada, considerando as quantidades, e este campo será ignorado.
finenumber
A multa do pagamento, em valor percentual. Ex.: para multa de 2% sobre o valor do pagamento vencido, envie 2.
interestnumber
O juros do pagamento, em valor percentual. Ex.: para 2% ao mês, envie 2.
custom_dataobject
Objeto no formato key-value para armazenar juntamente ao pagamento.
customerobjectobrigatórioCustomer
Os dados do cliente
customer object
Ver schema Customer
itemsarray de objectsPaymentItem
Os items que compõe esse pagamento. Obrigatório se o value não for informado. Se os items forem especificado para o pagamento, a soma do valor dos items será usada, considerando as quantidades, e o value será ignorado mesmo que esteja presente.
items array de objects
Ver schema PaymentItem
fraud_preventionobjectFraudPrevention
Os dados referentes a análise antifraude, se a empresa tiver contratado este serviço.
fraud_prevention object
Ver schema FraudPrevention
card_hashstring
O hash encriptado dos dados do cartão. Para entender o fluxo de criptografia consulte a documentação para hash de cartões. Obrigatório se o método é credit e o card não foi informado.
cardobjectCard
Os dados do cartão em formato puro. Atenção, para trafegar dados neste formato a sua infraestrutura deve ser PCI compliance. Obrigatório se o método é credit e o card_hash não foi informado.
card object
Ver schema Card
installmentsinteger≥ 1≤ 12
Se o método é credit, em quantas parcelas a compra deve ser processada.
due_datestringdate
A data de vencimento da cobrança. É utilizada para o vencimento do boleto e do pix. Obrigatório se o método é billet.

Respostas

200Pagamento criado com sucesso

Corpo da resposta

application/json

paymentobjectPayment
payment object
Ver schema Payment
customerobjectCustomer
customer object
Ver schema Customer

Exemplo

{
  "payment": {
    "id": 42,
    "uuid": "8b2cad02-06f0-42be-84ac-101b23a1bb0d",
    "value": 5000,
    "due_date": "2017-07-21"
  },
  "customer": {
    "id": 42,
    "name": "Jhon Doe",
    "email": "jhon@doe.com",
    "cpf": "833.828.600-15",
    "cnpj": "95.135.209/0001-79",
    "phone": "(11) 11111-1111",
    "cep": "01423-910",
    "address": "Rua José Maria Lisboa",
    "number": 42,
    "district": "Jardim Paulista",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR"
  }
}

401Não autenticado

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "AUTHENTICATION_ERROR",
  "message": "Não autenticado.",
  "timestamp": "2026-10-22T12:03:44+00:00",
  "request_id": "f2a7e962-6083-4525-816e-f14d4a602e0a",
  "documentation_url": "https://docs.ninepay.com.br"
}

422Erro na validação dos dados

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "VALIDATION_ERROR",
  "message": "Os dados informados são inválidos.",
  "errors": {
    "email": [
      "O campo email é obrigatório."
    ]
  },
  "timestamp": "2026-10-22T12:03:54+00:00",
  "request_id": "64d62d36-e797-45ed-a9d5-c203bde81032",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Corrija os campos e tente novamente."
}

500Erro inesperado

Corpo da resposta

application/json

codestring
O código do erro. Ex.: VALIDATION_ERROR, FORBIDDEN_ERROR, UNEXPECTED_ERROR.
messagestring
A mensagem do erro.
errorsobject
Os erros de cada campo, quando o code é VALIDATION_ERROR.
timestampstringdate-time
A data e hora do erro, em UTC.
request_idstring
Um identificador único gerado para esta resposta de erro.
documentation_urlstring
O endereço desta documentação.
suggestionstring
Uma sugestão de como resolver o erro.

Exemplo

{
  "code": "UNEXPECTED_ERROR",
  "message": "Houve um erro inesperado.",
  "timestamp": "2026-10-22T12:04:46+00:00",
  "request_id": "868443d3-38fd-4c92-8ea8-7cccbbce4308",
  "documentation_url": "https://docs.ninepay.com.br",
  "suggestion": "Verifique todos os parâmetros da requisição. Se o erro persistir, entre em contato com nossa equipe em ti@ninepay.com.br."
}

RECIPES

Parâmetros do body

Respostas

Credenciais

Resposta