Create Pix charge

curl --request POST \
  --url https://app.amplopay.com/api/v1/gateway/pix/receive \
  --header 'Content-Type: application/json' \
  --header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
  --header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
  --data '{
    "identifier": "pedido-123",
    "amount": 100,
    "client": {
      "name": "João da Silva",
      "email": "joao@email.com",
      "phone": "(11) 99999-9999",
      "document": "123.456.789-00"
    },
    "products": [
      {
        "id": "produto-1",
        "name": "Produto 1",
        "quantity": 1,
        "price": 100
      }
    ],
    "callbackUrl": "https://example.com/webhooks/payment"
  }'

{
  "transactionId": "clwuwmn4i0007emp9lgn66u1h",
  "status": "OK",
  "fee": 2.5,
  "order": {
    "id": "cm92389asdaskdjkasjdka",
    "url": "https://app.amplopay.com/order/cm92389asdaskdjkasjdka",
    "receiptUrl": "https://app.amplopay.com/order/cm92389asdaskdjkasjdka/receipt"
  },
  "pix": {
    "code": "00020101021126530014BR.GOV.BCB.PIX...",
    "image": "https://app.amplopay.com/api/v1/pix/qr/000201...",
    "base64": ""
  }
}

POST

gateway

pix

receive

curl --request POST \
  --url https://app.amplopay.com/api/v1/gateway/pix/receive \
  --header 'Content-Type: application/json' \
  --header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
  --header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
  --data '{
    "identifier": "pedido-123",
    "amount": 100,
    "client": {
      "name": "João da Silva",
      "email": "joao@email.com",
      "phone": "(11) 99999-9999",
      "document": "123.456.789-00"
    },
    "products": [
      {
        "id": "produto-1",
        "name": "Produto 1",
        "quantity": 1,
        "price": 100
      }
    ],
    "callbackUrl": "https://example.com/webhooks/payment"
  }'

{
  "transactionId": "clwuwmn4i0007emp9lgn66u1h",
  "status": "OK",
  "fee": 2.5,
  "order": {
    "id": "cm92389asdaskdjkasjdka",
    "url": "https://app.amplopay.com/order/cm92389asdaskdjkasjdka",
    "receiptUrl": "https://app.amplopay.com/order/cm92389asdaskdjkasjdka/receipt"
  },
  "pix": {
    "code": "00020101021126530014BR.GOV.BCB.PIX...",
    "image": "https://app.amplopay.com/api/v1/pix/qr/000201...",
    "base64": ""
  }
}

Creates a Pix charge.

Body parameters

string

required

Unique identifier for this transaction in your application.

number

required

Transaction amount in BRL.

object

required

Customer information.

string

required

Customer full name.

string

required

Customer email address.

string

required

Customer phone number.

string

required

Customer document, such as CPF or CNPJ for Brazilian customers.

array

Products included in the transaction.

string

required

Product identifier in your application.

string

required

Product name.

number

Product quantity.

number

required

Product unit price in BRL.

boolean

Indicates whether the product is physical.

number

Shipping fee in BRL.

number

Additional fee in BRL.

number

Discount amount in BRL.

array

Payment split configuration.

string

required

Producer ID that will receive the split amount.

number

required

Amount sent to the split receiver, in BRL.

object

Free-form metadata associated with the transaction.

string

Charge due date in YYYY-MM-DD format.

string

URL that will receive payment status webhook notifications.

Request example

curl --request POST \
  --url https://app.amplopay.com/api/v1/gateway/pix/receive \
  --header 'Content-Type: application/json' \
  --header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
  --header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
  --data '{
    "identifier": "pedido-123",
    "amount": 100,
    "client": {
      "name": "João da Silva",
      "email": "joao@email.com",
      "phone": "(11) 99999-9999",
      "document": "123.456.789-00"
    },
    "products": [
      {
        "id": "produto-1",
        "name": "Produto 1",
        "quantity": 1,
        "price": 100
      }
    ],
    "callbackUrl": "https://example.com/webhooks/payment"
  }'

Payload example

{
  "identifier": "pedido-123",
  "amount": 100,
  "client": {
    "name": "João da Silva",
    "email": "joao@email.com",
    "phone": "(11) 99999-9999",
    "document": "123.456.789-00"
  },
  "products": [
    {
      "id": "produto-1",
      "name": "Produto 1",
      "quantity": 1,
      "price": 100
    }
  ],
  "callbackUrl": "https://example.com/webhooks/payment"
}

Response

string

required

Transaction ID generated by the Gateway API.

string

required

Initial transaction status.

number

required

Transaction fee amount.

object

required

Order information and hosted order URL.

object

required

Pix payment information.

{
  "transactionId": "clwuwmn4i0007emp9lgn66u1h",
  "status": "OK",
  "fee": 2.5,
  "order": {
    "id": "cm92389asdaskdjkasjdka",
    "url": "https://app.amplopay.com/order/cm92389asdaskdjkasjdka",
    "receiptUrl": "https://app.amplopay.com/order/cm92389asdaskdjkasjdka/receipt"
  },
  "pix": {
    "code": "00020101021126530014BR.GOV.BCB.PIX...",
    "image": "https://app.amplopay.com/api/v1/pix/qr/000201...",
    "base64": ""
  }
}

QR Code note

The Pix base64 field is deprecated and returns an empty string. Render the QR Code from the qrCode or code field, depending on the endpoint response.

⌘I

Getting started

Endpoints

Webhooks

FAQ

Create Pix charge

Body parameters

Request example

Payload example

Response

QR Code note

​Body parameters

​Request example

​Payload example

​Response

​QR Code note

Body parameters

Request example

Payload example

Response

QR Code note