Initiate a Pix transfer (step 1)

curl --request POST \
  --url https://api.example.com/spi/v1/transfers/cashout/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "initiationType": "DICT",
  "description": "Pagamento de aluguel",
  "emv": "00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56",
  "endToEndId": "E12345678202605061030abcdef12345",
  "key": "+5511999998888"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/spi/v1/transfers/cashout/initiate"

	payload := strings.NewReader("{\n  \"initiationType\": \"DICT\",\n  \"description\": \"Pagamento de aluguel\",\n  \"emv\": \"00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56\",\n  \"endToEndId\": \"E12345678202605061030abcdef12345\",\n  \"key\": \"+5511999998888\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    initiationType: 'DICT',
    description: 'Pagamento de aluguel',
    emv: '00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56',
    endToEndId: 'E12345678202605061030abcdef12345',
    key: '+5511999998888'
  })
};

fetch('https://api.example.com/spi/v1/transfers/cashout/initiate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/spi/v1/transfers/cashout/initiate"

payload = {
    "initiationType": "DICT",
    "description": "Pagamento de aluguel",
    "emv": "00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56",
    "endToEndId": "E12345678202605061030abcdef12345",
    "key": "+5511999998888"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2026-05-06T10:30:00Z",
  "expiresAt": "2026-05-06T10:35:00Z",
  "id": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "initiationType": "DICT",
  "updatedAt": "2026-05-06T10:30:00Z",
  "amount": "10.00",
  "description": "Pagamento de aluguel",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    },
    "key": "+5511999998888"
  },
  "emv": "00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56",
  "endToEndId": "E12345678202605061030abcdef12345",
  "qrCodeDetails": "<unknown>",
  "source": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "key": "+5511999998888",
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    }
  }
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The X-Idempotency header is required for this operation and must be within the accepted length."
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The X-Idempotency header is held by a request still running or whose receipt could not be stored, or was already used with a different request."
}

{
  "code": "PIX-0016",
  "title": "Unsupported Media Type",
  "message": "The request body must be sent with Content-Type: application/json."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0303",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "DICT key lookup returned no results.",
  "code": "PIX-0303"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The server could not complete the request. Please try again later.",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0700",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "The server could not complete the request. Please try again later.",
  "code": "PIX-0700"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

transfers

cashout

initiate

Initiate a Pix transfer (step 1)

curl --request POST \
  --url https://api.example.com/spi/v1/transfers/cashout/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "initiationType": "DICT",
  "description": "Pagamento de aluguel",
  "emv": "00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56",
  "endToEndId": "E12345678202605061030abcdef12345",
  "key": "+5511999998888"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/spi/v1/transfers/cashout/initiate"

	payload := strings.NewReader("{\n  \"initiationType\": \"DICT\",\n  \"description\": \"Pagamento de aluguel\",\n  \"emv\": \"00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56\",\n  \"endToEndId\": \"E12345678202605061030abcdef12345\",\n  \"key\": \"+5511999998888\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("X-Account-Id", "<x-account-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    initiationType: 'DICT',
    description: 'Pagamento de aluguel',
    emv: '00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56',
    endToEndId: 'E12345678202605061030abcdef12345',
    key: '+5511999998888'
  })
};

fetch('https://api.example.com/spi/v1/transfers/cashout/initiate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/spi/v1/transfers/cashout/initiate"

payload = {
    "initiationType": "DICT",
    "description": "Pagamento de aluguel",
    "emv": "00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56",
    "endToEndId": "E12345678202605061030abcdef12345",
    "key": "+5511999998888"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2026-05-06T10:30:00Z",
  "expiresAt": "2026-05-06T10:35:00Z",
  "id": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "initiationType": "DICT",
  "updatedAt": "2026-05-06T10:30:00Z",
  "amount": "10.00",
  "description": "Pagamento de aluguel",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    },
    "key": "+5511999998888"
  },
  "emv": "00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56",
  "endToEndId": "E12345678202605061030abcdef12345",
  "qrCodeDetails": "<unknown>",
  "source": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "key": "+5511999998888",
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    }
  }
}

{
  "code": "PIX-0030",
  "title": "Idempotency Key Required",
  "message": "The X-Idempotency header is required for this operation and must be within the accepted length."
}

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The X-Idempotency header is held by a request still running or whose receipt could not be stored, or was already used with a different request."
}

{
  "code": "PIX-0016",
  "title": "Unsupported Media Type",
  "message": "The request body must be sent with Content-Type: application/json."
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0303",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "DICT key lookup returned no results.",
  "code": "PIX-0303"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0000",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The server could not complete the request. Please try again later.",
  "code": "PIX-0000"
}

{
  "type": "https://errors.lerian.studio/v1/PIX-0700",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "The server could not complete the request. Please try again later.",
  "code": "PIX-0700"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency

string

requerido

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. An identical resend within 1 hour returns the original response, status included, with X-Idempotency-Replayed: true. Reusing the key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64

X-Account-Id

string

requerido

Source account UUID

Ejemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Cuerpo

application/json

initiationType

string

requerido

Resolution strategy for the destination

Ejemplo:

"DICT"

description

string

Free-form payment description. U+0000 is refused (400 PIX-0010); U+FFFE, U+FFFF or U+0001-U+001F other than tab, line feed or carriage return is refused (400 PIX-0003).

Ejemplo:

"Pagamento de aluguel"

destination

object

Manual destination (MANUAL initiation only)

Show child attributes

emv

string

EMV BR Code payload (QR_CODE initiation only)

Ejemplo:

"00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56"

endToEndId

string

Optional caller-supplied 32-char BACEN endToEndId (E-prefixed). DICT and QR_CODE only: the key is looked up in DICT under it and the transfer is later sent under the same id; omit it to let SPI generate one, returned as endToEndId. Ignored for MANUAL.

Ejemplo:

"E12345678202605061030abcdef12345"

key

string

DICT key (DICT initiation only)

Ejemplo:

"+5511999998888"

Respuesta

Created

createdAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T10:30:00Z"

expiresAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T10:35:00Z"

string

requerido

Ejemplo:

"019606a1-3b4c-7d8e-9f01-234567890abc"

initiationType

string

requerido

Ejemplo:

"DICT"

updatedAt

string<date-time>

requerido

Ejemplo:

"2026-05-06T10:30:00Z"

amount

string

Ejemplo:

"10.00"

description

string

Ejemplo:

"Pagamento de aluguel"

destination

object

Show child attributes

emv

string

Ejemplo:

"00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56"

endToEndId

string

BACEN end-to-end id fixed at initiate for DICT and QR_CODE: the id the DICT lookup was made under, reused automatically by process as the transfer's id (do not send X-End-To-End-Id at process: it is refused for DICT and QR_CODE). Absent for MANUAL.

Ejemplo:

"E12345678202605061030abcdef12345"

qrCodeDetails

any

source

object

Show child attributes

DICT y claves Pix

Cobros y códigos BR

Pagos y devoluciones

API de Pix Automático

Manejo de errores

Initiate a Pix transfer (step 1)

Autorizaciones

Encabezados

Cuerpo

Respuesta