Creating a Charge using API

You can generate new Pix Charges using the OpenPix API in your backend or frontend

cURL

curl --location --request POST 'https://api.openpix.com.br/api/openpix/v1/charge' \
--header 'Content-Type: application/json' \
--header 'Authorization: <appID>' \
--data-raw '{
    "correlationID": "8a4a4168-a877-4494-9d8d-eba2d4435e97",
    "value": "1",
    "comment": "my first pix charge",
    "customer": {
        "name": "Bob",
        "email": "bob@openpix.com.br",
        "phone": "5511940468888",
        "taxID": "471.737.080-52"
    }
}'

JavaScript

const createCharge = async () => {
  const payload = {
    correlationID: '8a4a4168-a877-4494-9d8d-eba2d4435e97', // our system id
    value: 1, // 1 cent
    comment: 'my first pix',
    customer: {
      name: 'Bob',
      email: 'bob@openpix.com.br',
      taxID: '471.737.080-52',
      phone: '5511940468888'
    }
  }

  const response = await fetch('https://api.openpix.com.br/api/openpix/v1/charge', {
    method: 'POST',
    headers: {
      Accept: 'application/json',
      'Content-Type': 'application/json',
      Authorization: 'appID',
    },
    body: JSON.stringify(payload),
  });
  const data = await response.json();
  console.log({
    data,
  });
}

Payload Description

• correlationID: your ID to keep track of charge
• value: charge value in cents
• comment: comment to be shown in QRCode while the customer is payment the charge
• customer: customer of this charge
• customer.name: customer name
• customer.email: customer email
• customer.taxID: customer CPF/CNPJ
• customer.phone: customer phone

Customer field is not required. However, if you decide to use it, you must send at least one of the following combinations:

1. name + taxID
2. name + email
3. name + phone