POST
/
v1.1
/
checkout
/
pix-automatic
HttpResponse<String> response = Unirest.post("https://api.paymee.com.br/v1.1/checkout/pix-automatic")
  .header("x-api-key", "<x-api-key>")
  .header("x-api-token", "<x-api-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"currency\": \"BRL\",\n  \"referenceCode\": \"ref-journey2-xyz-123\",\n  \"maxAge\": 120,\n  \"callbackURL\": \"https://foo.bar/paymeeListener\",\n  \"shopper\": {\n    \"id\": \"24391203\",\n    \"email\": \"foo@bar.com\",\n    \"name\": \"JOHN DOE\",\n    \"document\": {\n      \"type\": \"CPF\",\n      \"number\": \"00000000000\"\n    },\n    \"phone\": {\n      \"type\": \"MOBILE\",\n      \"number\": \"11999990000\"\n    }\n  },\n  \"recurrence\": {\n    \"planId\": \"6852768495f9a7e75febdbe3\",\n    \"immediatePayment\": false,\n    \"amount\": {\n      \"recurrenceAmount\": 11\n    },\n    \"calendar\": {\n      \"initialDate\": \"2025-07-25\",\n      \"finalDate\": \"2025-12-25\",\n      \"periodicity\": \"MONTHLY\"\n    },\n    \"retry\": true\n  }\n}")
  .asString();
{
  "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": "jane@doe.com",
      "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

Response

200
application/json

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

The response is of type object.