Initiate a Pix Transfer

curl --request POST \
  --url https://api.example.com/v1/transfers/cashout/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --data '<string>'

package main

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

func main() {

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

	payload := strings.NewReader("<string>")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/octet-stream")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/octet-stream'},
  body: '<string>'
};

fetch('https://api.example.com/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/v1/transfers/cashout/initiate"

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/octet-stream"
}

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

print(response.text)

{
  "createdAt": "2024-01-15T10:30:00Z",
  "endToEndId": "E1234567820240101000001234567890",
  "expiresAt": "2024-01-15T11:00:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "initiationType": "MANUAL",
  "updatedAt": "2024-01-15T10:30:00Z",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "CACC"
    },
    "owner": {
      "document": "52998224725",
      "name": "John Doe",
      "type": "NATURAL_PERSON",
      "tradeName": "John's Business"
    },
    "key": "john.doe@example.com"
  },
  "emv": "00020126...5802BR5913Fulano...",
  "qrCodeDetails": "<unknown>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

POST

transfers

cashout

initiate

Initiate a Pix Transfer

curl --request POST \
  --url https://api.example.com/v1/transfers/cashout/initiate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --data '<string>'

package main

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

func main() {

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

	payload := strings.NewReader("<string>")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/octet-stream")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/octet-stream'},
  body: '<string>'
};

fetch('https://api.example.com/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/v1/transfers/cashout/initiate"

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/octet-stream"
}

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

print(response.text)

{
  "createdAt": "2024-01-15T10:30:00Z",
  "endToEndId": "E1234567820240101000001234567890",
  "expiresAt": "2024-01-15T11:00:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "initiationType": "MANUAL",
  "updatedAt": "2024-01-15T10:30:00Z",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "CACC"
    },
    "owner": {
      "document": "52998224725",
      "name": "John Doe",
      "type": "NATURAL_PERSON",
      "tradeName": "John's Business"
    },
    "key": "john.doe@example.com"
  },
  "emv": "00020126...5802BR5913Fulano...",
  "qrCodeDetails": "<unknown>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "title": "<string>",
  "fields": {},
  "headers": {},
  "paths": {},
  "queryParams": {},
  "raw": "<string>"
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Account-Id

string

Account ID (UUID format)

Cuerpo

application/octet-stream

The body is of type file.

Respuesta

Created

createdAt

string

requerido

Ejemplo:

"2024-01-15T10:30:00Z"

endToEndId

string

requerido

Ejemplo:

"E1234567820240101000001234567890"

expiresAt

string

requerido

Ejemplo:

"2024-01-15T11:00:00Z"

string

requerido

Ejemplo:

"550e8400-e29b-41d4-a716-446655440010"

initiationType

string

requerido

Ejemplo:

"MANUAL"

updatedAt

string

requerido

Ejemplo:

"2024-01-15T10:30:00Z"

destination

object

Show child attributes

emv

string

Ejemplo:

"00020126...5802BR5913Fulano..."

qrCodeDetails

any

API de DICT

API de Reclamaciones

MED · Infracciones

MED · Marcadores de fraude

MED · Solicitudes de devolución

MED · Estadísticas

API de Transacciones

API de Códigos QR

API de Cobros

API de Recuperación de Fondos

API de Conciliación

API de Pix Automático

API de Programaciones

API de Informes de Transacción

Tiempos de transacciones

API de Webhooks

Manejo de errores

Eventos

Initiate a Pix Transfer

Autorizaciones

Encabezados

Cuerpo

Respuesta