Pular para o conteúdo principal
API docs by Redocly

Pix Charge (1.0.0)

Download OpenAPI specification:Download

Pix Charge

pixCharge

Endpoint to manage Pix Charges

Create a new Pix charge

Create a new Pix charge with the specified parameters

path Parameters
txid
required
string

Unique transaction identifier

Request Body schema: application/json
required
value
required
number

Charge amount in cents

key
required
string

PIX key for the charge

keyType
required
string
Enum: "CPF" "CNPJ" "EMAIL" "PHONE" "EVP"
expiresAt
string <date-time>

Optional expiration date

Responses

Request samples

Content type
application/json
{
  • "value": 0,
  • "key": "string",
  • "keyType": "CPF",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "txid": "string",
  • "status": "ACTIVE",
  • "value": 0,
  • "key": "string",
  • "keyType": "CPF",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "txi": "string"
}

Update an existing Pix charge

Update an existing Pix charge with new parameters

path Parameters
txid
required
string

Unique transaction identifier

Request Body schema: application/json
required
value
number

Charge amount in cents

key
string

PIX key for the charge

keyType
string
Enum: "CPF" "CNPJ" "EMAIL" "PHONE" "EVP"
expiresAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "value": 0,
  • "key": "string",
  • "keyType": "CPF",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "txid": "string",
  • "status": "ACTIVE",
  • "value": 0,
  • "key": "string",
  • "keyType": "CPF",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "txi": "string"
}

Delete a Pix charge

Delete a specific Pix charge

path Parameters
txid
required
string

Unique transaction identifier

Responses

Request samples 

const http = require('https');

const options = {
  method: 'DELETE',
  hostname: '',
  port: null,
  path: '%3Cname%3E.indireto.woovi-indireto.dev/charge/pix-charge/v1/charge/%7Btxid%7D',
  headers: {}
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on('data', function (chunk) {
    chunks.push(chunk);
  });

  res.on('end', function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Get Pix charges by location

Retrieve all Pix charges associated with a specific location

path Parameters
locId
required
string

Location identifier

Responses

Request samples 

const http = require('https');

const options = {
  method: 'GET',
  hostname: '',
  port: null,
  path: '%3Cname%3E.indireto.woovi-indireto.dev/charge/pix-charge/v1/charge/location/%7BlocId%7D',
  headers: {}
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on('data', function (chunk) {
    chunks.push(chunk);
  });

  res.on('end', function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Response samples

Content type
application/json
{
  • "locId": "string",
  • "charges": [
    ]
}

Check if a Pix charge is allowed to be paid

Check if a Pix charge is allowed to be paid

path Parameters
txid
required
string

Unique transaction identifier

Request Body schema: application/json
required
allowed
boolean

Whether to allow payment

Responses

Request samples

Content type
application/json
{
  • "allowed": true
}

Response samples

Content type
application/json
{
  • "allowed": true
}

pix-charge

Endpoints for pix-charge

Get a pix charge

Retrieve details of a specific Pix charge

path Parameters
txid
required
string
Example: 6290ccfd42831958a405debc

pix charge txid

Responses

Request samples 

const http = require('https');

const options = {
  method: 'GET',
  hostname: '',
  port: null,
  path: '%3Cname%3E.indireto.woovi-indireto.dev/charge/pix-charge/v1/charge/6290ccfd42831958a405debc',
  headers: {}
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on('data', function (chunk) {
    chunks.push(chunk);
  });

  res.on('end', function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Response samples

Content type
application/json
{
  • "account": {
    }
}