Meio de Pagamento: Pix

Create a QRCode

post

This endpoint creates a new qrcode with the provided data.

Body

application/json

amountnumberRequired

customer_codestringOptional

descriptionstringRequired

expirationinteger · min: 60Required

notification_urlstringOptional

Responses

201

Created

application/json

stringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post/v1/pix

HTTPcURLJavaScriptPython

POST //sandbox-api.pagou.com.br/v1/pix HTTP/1.1
Host: https:/
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "amount": 1,
  "customer_code": "text",
  "description": "text",
  "expiration": 1,
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "notification_url": "text",
  "payer": {
    "document": "text",
    "name": "text"
  }
}

text

Get a QRCode

get

This endpoint return a qrcode.

Path parameters

qrcodeIDstringRequired

QRCode ID

Responses

200

OK

application/json

stringOptional

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/v1/pix/{qrcodeID}

HTTPcURLJavaScriptPython

GET //sandbox-api.pagou.com.br/v1/pix/{qrcodeID} HTTP/1.1
Host: https:/
Accept: */*

text

Refund a QRCode

delete

This endpoint requests a refund for a qrcode with the provided data.

Path parameters

qrcodeIDstringRequired

QRCode ID

Body

application/json

amountnumberRequired

descriptionstringRequired

reasonintegerRequired

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

delete/v1/pix/{qrcodeID}/refund

HTTPcURLJavaScriptPython

DELETE //sandbox-api.pagou.com.br/v1/pix/{qrcodeID}/refund HTTP/1.1
Host: https:/
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "amount": 1,
  "description": "text",
  "reason": 1
}

No content

Cancel a QRCode

delete

This endpoint requests a cancellation for an active qrcode with the provided data.

Path parameters

qrcodeIDstringRequired

QRCode ID

Responses

204

No Content

No content

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

delete/v1/pix/{qrcodeID}

HTTPcURLJavaScriptPython

DELETE //sandbox-api.pagou.com.br/v1/pix/{qrcodeID} HTTP/1.1
Host: https:/
Accept: */*

No content