Initiate a Pix transfer (step 1)

cURL with fictitious data

curl --request POST \
  --url https://api.example.com/spi/v1/transfers/cashout/initiate \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: pix-demo-20260903-000001' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc' \
  --data '{
  "description": "Pagamento de aluguel",
  "endToEndId": "E12345678202605061030abcdef12345",
  "initiationType": "DICT",
  "key": "pix-demo@example.com"
}'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"description\": \"Pagamento de aluguel\",\n  \"endToEndId\": \"E12345678202605061030abcdef12345\",\n  \"initiationType\": \"DICT\",\n  \"key\": \"pix-demo@example.com\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    description: 'Pagamento de aluguel',
    endToEndId: 'E12345678202605061030abcdef12345',
    initiationType: 'DICT',
    key: 'pix-demo@example.com'
  })
};

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 = {
    "description": "Pagamento de aluguel",
    "endToEndId": "E12345678202605061030abcdef12345",
    "initiationType": "DICT",
    "key": "pix-demo@example.com"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "amount": "10.00",
  "createdAt": "2026-05-06T10:30:00Z",
  "description": "Pagamento de aluguel",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "key": "pix-demo@example.com",
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    }
  },
  "endToEndId": "E12345678202605061030abcdef12345",
  "expiresAt": "2026-05-06T10:35:00Z",
  "id": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "initiationType": "DICT",
  "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"
    }
  },
  "updatedAt": "2026-05-06T10:30:00Z"
}

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

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

{
  "code": "ERR-0001",
  "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

cURL with fictitious data

curl --request POST \
  --url https://api.example.com/spi/v1/transfers/cashout/initiate \
  --header 'Authorization: Bearer demo-access-token' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: pix-demo-20260903-000001' \
  --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc' \
  --data '{
  "description": "Pagamento de aluguel",
  "endToEndId": "E12345678202605061030abcdef12345",
  "initiationType": "DICT",
  "key": "pix-demo@example.com"
}'

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"description\": \"Pagamento de aluguel\",\n  \"endToEndId\": \"E12345678202605061030abcdef12345\",\n  \"initiationType\": \"DICT\",\n  \"key\": \"pix-demo@example.com\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    description: 'Pagamento de aluguel',
    endToEndId: 'E12345678202605061030abcdef12345',
    initiationType: 'DICT',
    key: 'pix-demo@example.com'
  })
};

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 = {
    "description": "Pagamento de aluguel",
    "endToEndId": "E12345678202605061030abcdef12345",
    "initiationType": "DICT",
    "key": "pix-demo@example.com"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "amount": "10.00",
  "createdAt": "2026-05-06T10:30:00Z",
  "description": "Pagamento de aluguel",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "0007654321",
      "participant": "87654321",
      "type": "CACC"
    },
    "key": "pix-demo@example.com",
    "owner": {
      "document": "12345678901",
      "name": "João da Silva",
      "tradeName": "Empresa Exemplo LTDA",
      "type": "NATURAL_PERSON"
    }
  },
  "endToEndId": "E12345678202605061030abcdef12345",
  "expiresAt": "2026-05-06T10:35:00Z",
  "id": "019606a1-3b4c-7d8e-9f01-234567890abc",
  "initiationType": "DICT",
  "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"
    }
  },
  "updatedAt": "2026-05-06T10:30:00Z"
}

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

{
  "code": "PIX-0031",
  "title": "Idempotency Key Conflict",
  "message": "The Idempotency-Key was already used with a different request."
}

{
  "code": "ERR-0001",
  "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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key

string

required

Client-generated key used to retry exactly the same request safely.

Required string length: 1 - 64

X-Account-Id

string

required

UUID of the account associated with the operation.

Example:

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

Body

application/json

initiationType

string

required

Resolution strategy for the destination

Example:

"DICT"

description

string

Free-form payment description

Example:

"Pagamento de aluguel"

destination

object

Manual destination (MANUAL initiation only)

Show child attributes

emv

string

EMV BR Code payload (QR_CODE initiation only)

Example:

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

endToEndId

string

Optional caller-supplied 32-char BCB endToEndId

Example:

"E12345678202605061030abcdef12345"

key

string

DICT key (DICT initiation only)

Example:

"+5511999998888"

Response

Created

createdAt

string<date-time>

required

Example:

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

expiresAt

string<date-time>

required

Example:

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

string

required

Example:

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

initiationType

string

required

Example:

"DICT"

updatedAt

string<date-time>

required

Example:

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

amount

string

Example:

"10.00"

description

string

Example:

"Pagamento de aluguel"

destination

object

Show child attributes

emv

string

Example:

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

endToEndId

string

Example:

"E12345678202605061030abcdef12345"

qrCodeDetails

any

source

object

Show child attributes

DICT and Pix keys

Collections and BR Codes

Payments and refunds

Error handling

Initiate a Pix transfer (step 1)

Authorizations

Headers

Body

Response