Skip to main content
POST
/
pix
/
v1
/
payment
Criar Pagamento
curl --request POST \
  --url https://api.pagou.ai/pix/v1/payment \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '{
  "type": "PIX",
  "transaction": {
    "value": 1.15,
    "description": "Cobrança de teste",
    "expirationTime": 300,
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "payer": {
    "fullName": "John Marvin",
    "document": "12312312387",
    "contact": {
      "phone": "11999887766",
      "mail": "john.marvin@mail.com"
    }
  }
}'
{
  "transactionId": "cd722e93-032f-45e1-b638-87a2490dcea7",
  "status": "WAITING_PAYMENT",
  "pixQrCode": "iVBORw0KGgoAAAANSUhEUgAABbQAAAW0CAYAAAAeooXXAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAIABJREFUeJzs2kGu5DqSRNFmI/a/ZfbwVw7+Q2XLM2UWfs4CBKdIKQIXOvfe+z8AAAAAABDuf98eAAAAAAAA...",
  "pixCode": "00020101021226880014br.gov.bcb.pix2566qrcode-h.pagou.ai/QR/cob/EEA7B851BBAFFB546073CE80810F56AA0F95204000053039865802BR592VENDEDOR TESTE6009Sao Paulo610905726-10062070503***630498E0",
  "generateTime": "2024-04-14T02:58:04.997Z",
  "expirationDate": "2024-04-15T02:58:04.997Z",
  "paymentLink": "https://pay.pagou.ai/cd722e93-032f-45e1-b638-87a2490dcea7"
}

Authorizations

​
apiKey
string
header
required

Body

application/json
​
type
enum<string>
required

Payment method type

Available options:
PIX
Example:

"PIX"

​
transaction
object
required
​
payer
object
required

Response

Payment created successfully

​
transactionId
string<uuid>

Unique transaction identifier

Example:

"cd722e93-032f-45e1-b638-87a2490dcea7"

​
status
string

Current payment status

Example:

"WAITING_PAYMENT"

​
pixQrCode
string

Base64 encoded QR code image for PIX payment

Example:

"iVBORw0KGgoAAAANSUhEUgAABbQAAAW0CAYAAAAeooXXAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAIABJREFUeJzs2kGu5DqSRNFmI/a/ZfbwVw7+Q2XLM2UWfs4CBKdIKQIXOvfe+z8AAAAAABDuf98eAAAAAAAA..."

​
pixCode
string

PIX code string for manual payment entry

Example:

"00020101021226880014br.gov.bcb.pix2566qrcode-h.pagou.ai/QR/cob/EEA7B851BBAFFB546073CE80810F56AA0F95204000053039865802BR592VENDEDOR TESTE6009Sao Paulo610905726-10062070503***630498E0"

​
generateTime
string<date-time>

Timestamp when the payment was generated

Example:

"2024-04-14T02:58:04.997Z"

​
expirationDate
string<date-time>

Payment expiration timestamp

Example:

"2024-04-15T02:58:04.997Z"

​
paymentLink
string<uri>

Direct payment link for web-based payment

Example:

"https://pay.pagou.ai/cd722e93-032f-45e1-b638-87a2490dcea7"

⌘I