v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Criar cobrança - PIX

Este recurso permite a criação de um PIX cobrança.

post/charges

Request body

paymentMethodstring required

Método de pagamento da cobrança.

dueDatestring date required

Data de vencimento da cobrança.<br>Formato: <code>YYYY-MM-DD</code>.

valuenumber double required

Valor da cobrança <code>precisão 2</code>.

abatementValuenumber double

Valor do Abatimento. <code>precisão 2</code>.

interestType'fixed_value' | 'percentage'

Tipo de juros aplicado a cobrança.<br>Valores permitidos <code>fixed_value</code> ou <code>percentage</code>.

interestValuenumber double

Valor dos juros por mês. Valores inteiros ou decimais com <code>precisão 2</code>.

applicableFinenumber double

Multa por atraso em valor percentual. <code>precisão 2</code>.

clientControlNumberstring

Identificador próprio de uso da empresa.<br><code>Alfanumérico - 25 caracteres</code>

expiresAfterinteger

Dias para baixa após o vencimento.

receiptNumberstring

Número da nota fiscal vinculada a cobrança.

Response

200

Example response

{
  "data": {
    "id": "788aa1e9-7f2e-4cdb-83ab-405254b80358",
    "type": "charge",
    "attributes": {
      "createdAt": "2023-12-07T17:43:26.207-03:00",
      "updatedAt": "2023-12-07T17:43:26.207-03:00",
      "status": "pending",
      "paymentMethod": "pix",
      "dueDate": "2023-12-30",
      "value": 699.09,
      "discount": {
        "range": "2023-12-08",
        "discountType": "percentage",
        "discountValue": 20
      },
      "abatementValue": 5.2,
      "interestType": "percentage",
      "interestValue": 2,
      "applicableFine": 2,
      "payer": {
        "data": {
          "type": "payer",
          "attributes": {
            "name": "Grand Moff Tarkin",
            "documentNumber": "12345679891",
            "email": "grandMoff.tarkin@dunder-mifflin.paper",
            "address": {
              "street": "Rua Dr. Albuquerque Lins",
              "number": "2222",
              "complement": "Apt 222",
              "zipCode": "01230-000",
              "neighborhood": "Santa Cecília",
              "city": "São Paulo",
              "state": "SP"
            },
            "phone": {
              "countryCode": "55",
              "areaCode": "51",
              "number": "995562211"
            }
          }
        }
      },
      "grantor": {
        "data": {
          "type": "grantor",
          "attributes": {
            "name": "George Lucas",
            "documentNumber": "88650081000116",
            "address": {
              "street": "Avenida Vinte de Setembro",
              "number": "456",
              "complement": "Apto 987",
              "zipCode": "93819-300",
              "neighborhood": "São Jacó",
              "city": "Sapiranga",
              "state": "RS"
            }
          }
        }
      },
      "fees": {
        "data": [
          {
            "id": "109642",
            "type": "event",
            "attributes": {
              "kind": "charge_pix_registered_cost"
            }
          }
        ]
      },
      "clientControlNumber": "7543649847645556555553425",
      "origin": "api",
      "expiresAfter": 90,
      "titleType": "several",
      "pixData": {
        "data": {
          "id": "1edf7bc2-8101-4e10-bef5-0b90e2da7506",
          "type": "pix",
          "attributes": {
            "emv": "00020101021226970014br.gov.bcb.pix2575qr-h.cornerpix.com.br/11581339/v2/cobv/03eef325-29ca-43ef-a967-f5c5ad3320df5204000053039865802BR5914BMP MONEY PLUS6009SAO PAULO62070503***63044D7B",
            "encodedImage": "iVBORw0KGgoAAAANSUhEUgAAAhIAAAISAQAAAACxRhsSAAAErklEQVR4nO2cUYrjMAyGf20CfXRgDjBHSW629GbOUXqABeexkKB9sGU7me7MwrTebvn9UCaT5MMBIUu/ZIviu2P+8W0EQAYZZJBBBhlkkEEGGYUhafSQaRERGTb7sRsANpEJsEdE4uWzfQsZr8iAqqpiVFXV0CngVNW7FYDTeIlRVQG3QlVXqIZOq9f8s3wLGa/PWMw7jpfsJwGoXnroedgEQFdpA+Zj7z0PMsj4e8Z4OSmwiGAeNpGfl2STIgMgU7N5kEFGHP3hWuehWwVuhc4TIOnf3Yp56ldgOb5wp3mQQcan4xifjgEAUEegGAOgGoAYvTI+JeMfMWYRERkAAMlYZVp6mAPtVCZ0ivHSQyYkIeD+8yCDjNtDP4yS1gOW6quq/9Mb9KdkNGLE/EikB2Y5KbCcFPOA6GhLVJoEK2wSPfB053mQQcbnjEVEvbuK/Az1bfVuhXp3lRi4jpeT1pLU3edBBhk3R1q8Q5d/ENd9jPajHrt8y8c3O677ZLRimP0FIBmhKwm+lac0dFajQr5BOyWjHaPKiuJ1XSPNddMoWHVmwPHhjroUGc0Zm6SC/tIDY+hUZNgkBq7n9xXq8yOz9Ck0eMA8yCDj1rC4MwlRKTQNXQxDS2ga1/1YBYgyFf0pGc0Yed1fUYpSxQjNYrskrHrArNhRPyWjGcMUpuVNgeVtBdwKgQvVMwIAMnoAcL96xQII3NYj/u9ZvoWM12XYog4T8ZPylBL8VNXPa3ydQq2gPyWjESPbaWkuTWt8/CtbbJX05/iUdkpGI0bWTw/miF0YGoCoVXmTU4HifJ/lW8h4XcYH/RRxy0lZ8vNzId/Ng3ZKRhvGUbUvG6JSbp+9rRax397guk9GW8ao17ot6jzAKlNL3nJSxP6lj4V/me49DzLIuD2sPLrufKemWLTqP81bTQ+lVfpTMh7PqNd9ALWxelfX/GO1yu9fZnxKRhtGpUslNcp9zKg8gKoFJZqyMt8noz1jk9jKP4ZNko9deqheTmlrFJyqTEi9KUjq6t3nQQYZt0alS+XlPY7oLKNq+uEHzPfJaMio+/n9/k6sPcEao0urFHV+Mlozdn195fCoYrYWpJqIirqviv6UjLaMJe0yjaf0TW6FTC5vjQoA5ve02iMGs+/UT8loxshN0CaiVnv13W57SdZUqyZU+lMy2jB2ddOQ/+vyyh5SfGpdf7mpn3kUGe0YVT3KMioAyN18dVtK6jq1vX1gHkVGK8ZOl8ol00O65IG6ZDoGgP2nZLRkVP381geVO/t3DlRztao0VdNOyWjEqHQpU0izEKW5vh/2YQCAuv/vWb6FjNdlHE/f2yn5+1p+KAf6lBu0UzJaMHK+D6CU7CtNP+w3TpVNUoxPyWjOGC3VlwkA5gEQed9rqu5qB/PG6HXjOb1ktGLszkErm0mdrfYAdpGq1l1/9Kdk/CNGKkUtPfQsp6RLnYdNktkudtp5OgH9UfMgg4xPGWPYJC3q7monRsfqfw9rm7b41D9uHmSQUQ/TpXKWXw6WKJukAlAi1XLJdZ+MRoxjvl8V+esz/FRLjeqwa5p2SsbjGaJfP/PFmJ/lW8gggwwyyCCDDDLI+P8ZvwFjNzf6WprlpAAAAABJRU5ErkJggg=="
          }
        }
      }
    }
  }
}