Skip to main content
POST
/
v1.1
/
checkout
/
pix-automatic
curl --request POST \
  --url https://api.paymee.com.br/v1.1/checkout/pix-automatic \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>' \
  --data '
{
  "currency": "BRL",
  "referenceCode": "ref-journey2-xyz-123",
  "maxAge": 120,
  "callbackURL": "https://foo.bar/paymeeListener",
  "shopper": {
    "id": "24391203",
    "email": "[email protected]",
    "name": "JOHN DOE",
    "document": {
      "type": "CPF",
      "number": "00000000000"
    },
    "phone": {
      "type": "MOBILE",
      "number": "11999990000"
    }
  },
  "recurrence": {
    "planId": "6852768495f9a7e75febdbe3",
    "immediatePayment": false,
    "amount": {
      "recurrenceAmount": 11
    },
    "calendar": {
      "initialDate": "2025-07-25",
      "finalDate": "2025-12-25",
      "periodicity": "MONTHLY"
    },
    "retry": true
  }
}
'
{
  "status": 0,
  "message": "success",
  "response": {
    "id": 215832474,
    "referenceCode": "ref-journey3-abc-456",
    "amount": 15,
    "saleCode": "215832474",
    "uuid": "ed700503-e3e0-3c3f-867f-0bd7bba3424a",
    "shopper": {
      "id": "24391204",
      "name": "JOHN DOE",
      "email": "[email protected]",
      "document": {
        "type": "CPF",
        "number": "00000000000"
      },
      "phone": {
        "type": "MOBILE",
        "number": "11999990000"
      }
    },
    "instructions": {
      "chosen": "PIX_RECURRENCE",
      "name": "Pagamento Recorrente via PIX",
      "label": "Pagamento Recorrente via PIX",
      "qrCode": {
        "url": "https://api.paymee.com.br/resources/payments/pix/qrcode/ed700503-e3e0-3c3f-867f-0bd7bba3424a",
        "base64": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6CAIAAAAHjs1q... (base64 image data)",
        "plain": "00020101021226930014br.gov.bcb.pix... (qr code text)"
      },
      "steps": {
        "qrCode": [
          "Acesse o APP ou o Internet Banking do seu Banco",
          "Acesse o menu PIX",
          "Abra o leitor de QRCode no APP e escaneie o código informado",
          "Siga os passos no APP e finalize a transação"
        ]
      }
    }
  }
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Body

application/json
​
currency
string

ISO-4217 currency code.

Example:

"BRL"

​
referenceCode
string

Unique order identifier.

Example:

"ref-jornada2-xyz-123"

​
amount
number

Required only when recurrence.immediatePayment is true (Journey 3).

Example:

11

​
maxAge
number

QR Code expiration time in minutes.

Example:

120

​
callbackURL
string

Callback URL for transaction updates.

Example:

"https://foo.bar/paymeeListener"

​
shopper
object
​
recurrence
object

Response

Pix Automatic journey created successfully. The response contains QR code instructions to start the flow.

​
status
integer
​
message
string
​
response
object