Pular para o conteúdo principal

Como usar a API de Criar Pagamentos?

Como criar Pagamentos via API ?​

Nós disponibilizamos o endpoint /api/v1/payment para que você possa criar um novo payment para a respectiva empresa afiliada.

Você pode acessar aqui a documentação referente a esse endpoint.

Como parte do body da requisição, possuímos dois modos de pagamento, por chave Pix e por QR Code:

  1. Por chave Pix, esperamos o envio obrigatório dos itens value, destinationAlias, destinationAliasType e correlationID.
  2. Por QR Code, esperamos o envio obrigatório dos itens qrCode e correlationID.

Abaixo temos a descrição de cada campo junto dos opcionais:

  • value: O valor em centavos do pagamento a ser criado.
  • destinationAlias: A chave pix destinatária do pagamento criado.
  • destinationAliasType: A tipo da chave pix destinatária do pagamento criado. Deve ser um dos seguintes valores: CPF, CNPJ, EMAIL, PHONE, RANDOM.
  • qrCode: O QR Code a ser pago
  • correlationID: Um identificador único para o pagamento.
  • comment: Comentário que será atrelado a seu pagamento quando a transferencia for realizada.
  • sourceAccountId: O ID da conta de origem, se não informado será utilizado a conta padrão.

Num exemplo prático, o body da sua requisição seguiria semelhante a este exemplo:

{
  "value": 100,
  "destinationAlias": "38763885700",
  "destinationAliasType": "CPF",
  "correlationID": "31ee9576-99ec-412a-9ac7-e142a4a6acf0",
  "comment": "um comentário"
}

Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, você estará vendo as informações sobre o payment recém criado.

Num exemplo, essa será a nossa resposta:

{
  "payment": {
    "value": 100,
    "status": "CREATED",
    "destinationAlias": "c4249323-b4ca-43f2-8139-8232aab09b93",
    "destinationAliasType": "RANDOM",
    "comment": "payment comment",
    "correlationID": "payment1",
    "sourceAccountId": "my-source-account-id"
  }
}