Create Deposit

POST

/deposits

Creates a new PIX deposit with automatic conversion to DePix.

Requisição

Authorization

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Deposit created successfully.

Body

🟠400

🟠401

🟠422

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/deposits' \
--header 'X-FlamPix-Key;' \
--header 'X-FlamPix-Key;' \
--header 'X-FlamPix-Timestamp;' \
--header 'X-FlamPix-Timestamp;' \
--header 'X-FlamPix-Signature;' \
--header 'X-FlamPix-Signature;' \
--header 'X-Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amountInCents": 1,
    "destinationAddress": "string",
    "customer": {
        "name": "string",
        "taxNumber": "string",
        "euid": "EU012090876034124"
    },
    "reference": "string",
    "metadata": {
        "whitelist": true
    }
}'

Response Example

{
    "depositId": "33504022-daeb-4ddf-96f2-fc15aa4e6a52",
    "status": "awaiting_payment",
    "amount": {
        "grossInCents": 0,
        "feeInCents": 0,
        "netInCents": 0
    },
    "pix": {
        "qrCopyPaste": "string",
        "qrImageUrl": "http://example.com"
    },
    "feeBreakdown": {
        "percentInCents": 0,
        "fixedInCents": 0,
        "gatewayInCents": 0,
        "totalInCents": 0
    },
    "createdAt": "2019-08-24T14:15:22Z"
}

Modificado em 2025-12-22 21:14:25