Pular para o conteúdo principal
POST
/
v1
/
transfers
Enviar transferência Pix
curl --request POST \
  --url https://conta-public-api.kiwify.com/v1/transfers \
  --header 'Content-Type: application/json' \
  --header 'X-PoP-Challenge: <api-key>' \
  --header 'X-PoP-Format: <api-key>' \
  --header 'X-PoP-Signature: <api-key>' \
  --header 'x-access-id: <api-key>' \
  --data '
{
  "transfers": [
    {
      "amount_in_cents": 123,
      "pix_key": "<string>",
      "type": "pix_key",
      "display_description": "<string>",
      "external_reference_id": "<string>",
      "scheduled_date": "2023-12-25"
    }
  ],
  "allowed_tax_ids": [
    "<string>"
  ]
}
'
{
  "batch": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": 123,
    "origin_bank_account_id": 123,
    "payment_type": "pix_transfer",
    "status": "created",
    "total_amount_in_cents": 123,
    "total_items": 123,
    "allowed_tax_ids": [
      "<string>"
    ],
    "idempotency_key": "<string>"
  },
  "transfers": [
    {
      "amount_in_cents": 123,
      "beneficiary": {
        "pix_key": "<string>",
        "name": "<string>",
        "tax_id": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "id": 123,
      "status": "awaiting_approval",
      "display_description": "<string>",
      "external_reference_id": "<string>",
      "failed_message": "<string>",
      "scheduled_date": "2023-12-25",
      "transaction_id": 123
    }
  ]
}

Autorizações

​
x-access-id
string
header
obrigatório

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

​
X-PoP-Challenge
string
header
obrigatório

Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5 minutes of server time.

​
X-PoP-Format
string
header
obrigatório

Must be 'service-account' for service account authentication

​
X-PoP-Signature
string
header
obrigatório

EdDSA signature of the request in base64 format. Signs: uri:method:body:timestamp

Cabeçalhos

​
X-Idempotency-Key
string | null

Optional idempotency key for safe retries. When provided, requests with the same key return the same result. Without this header, duplicate external_reference_id values will fail with 400 Bad Request.

Corpo

application/json
​
transfers
object[]
obrigatório
​
allowed_tax_ids
string[]

Optional list of CPF/CNPJ that restricts the allowed beneficiary documents for this batch. For pix_key transfers: the document resolved from the PIX key must match one of the listed values. For bank_account transfers: the tax_id provided in the transfer must be present in the list. When empty, transfers to any document are accepted.

Resposta

Transfers batch created successfully

​
batch
object
obrigatório
​
transfers
object[]
obrigatório