Skip to main content
POST
/
v1
/
deposits
Criar cobrança PIX
curl --request POST \
  --url https://api.swytchpay.app/v1/deposits \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount_cents": 1,
  "external_id": "<string>",
  "expires_in_sec": 44100,
  "callback_url": "<string>",
  "metadata": {}
}
'
{
  "id": "<string>",
  "object": "deposit",
  "external_id": "<string>",
  "amount_cents": 123,
  "fee_cents": 123,
  "net_cents": 123,
  "pix": {
    "emv": "<string>",
    "qr_url": "<string>"
  }
}

Body

application/json
amount_cents
integer
required
Required range: x > 0
external_id
string
Required string length: 1 - 120
payer
object
expires_in_sec
integer
Required range: 1800 <= x <= 86400
callback_url
string<uri>
metadata
object

Response

external_id repetido — retorna o existente (idempotente)

id
string
required
object
enum<string>
required
Available options:
deposit
external_id
string
required
status
enum<string>
required
Available options:
PENDING,
PAID,
EXPIRED,
REFUNDED,
FAILED
amount_cents
integer
required
fee_cents
integer
required
net_cents
integer
required
pix
object
required
environment
enum<string>
required
Available options:
live,
test
{key}
unknown