Skip to main content
POST
/
v1
/
charges
Cria cobrança Pix
curl --request POST \
  --url https://stater.stric.io/v1/charges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "variant": "simple",
  "amountCents": "<string>",
  "tag": "<string>",
  "expirationDate": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "pixAccountId": "<string>",
  "variant": "simple",
  "status": "PENDING",
  "txid": "<string>",
  "amountCents": "<string>",
  "brCode": "<string>",
  "imageUrl": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "fineDate": "2023-11-07T05:31:56Z",
  "debtorName": "<string>",
  "debtorDocument": "<string>",
  "debtorTypeDocument": "<string>",
  "typeFine": "<string>",
  "fine": 123,
  "tag": "<string>",
  "endToEndId": "<string>",
  "paidAt": "2023-11-07T05:31:56Z",
  "payerName": "<string>",
  "payerDocument": "<string>",
  "payerInstitution": "<string>",
  "refundEndToEndId": "<string>",
  "refundedAt": "2023-11-07T05:31:56Z",
  "refundedAmountCents": "<string>",
  "failureReason": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.stric.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key da plataforma. Envie no header Authorization: Bearer <key>.

Headers

​
X-Pix-Account-Id
string

Id da conta Pix sobre a qual a operação atua. Obrigatório quando sua API key não está vinculada a uma conta específica.

Required string length: 10 - 40
​
Idempotency-Key
string
required

Chave única para deduplicar requests. Repetir a mesma chave (mesmo método, path e body) retorna a resposta original — útil para retry seguro. Conflito de body com chave repetida → 409.

Required string length: 8 - 64

Body

application/json
​
variant
enum<string>
required
Available options:
simple
​
amountCents
required
​
tag
string
Required string length: 1 - 200
​
expirationDate
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

OK

​
id
string
required
​
pixAccountId
string
required
​
variant
enum<string>
required
Available options:
simple,
debtor,
cobv
​
status
enum<string>
required
Available options:
PENDING,
PAID,
EXPIRED,
FAILED,
REFUNDED,
CANCELLED
​
txid
string
required
​
amountCents
string<int64-string>
required

BigInt serializado como string decimal (Fastify default + convenção da plataforma).

Pattern: ^-?\d+$
​
brCode
string | null
required
​
imageUrl
string | null
required
​
expiresAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
dueDate
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
fineDate
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
debtorName
string | null
required
​
debtorDocument
string | null
required
​
debtorTypeDocument
string | null
required
​
typeFine
string | null
required
​
fine
number | null
required
​
tag
string | null
required
​
endToEndId
string | null
required
​
paidAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
payerName
string | null
required
​
payerDocument
string | null
required
​
payerInstitution
string | null
required
​
refundEndToEndId
string | null
required
​
refundedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
refundedAmountCents
string<int64-string>
required

BigInt serializado como string decimal (Fastify default + convenção da plataforma).

Pattern: ^-?\d+$
​
failureReason
string | null
required
​
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
{key}
any