Process a Pix Transfer

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --data '<string>'

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process"

	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://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process"

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

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

print(response.text)

{
  "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "amount": "100.50",
  "createdAt": "2024-01-15T10:30:15Z",
  "endToEndId": "E1234567820240101000001234567890",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "initiationType": "KEY",
  "paymentType": "IMMEDIATE",
  "purpose": "TRANSFER",
  "status": "COMPLETED",
  "type": "CASHIN",
  "updatedAt": "2024-01-15T10:35:00Z",
  "urgency": "HIGH",
  "aliasId": "01989f9e-6508-79f8-9540-835be49fbd0e",
  "deletedAt": "<string>",
  "description": "Pix Cashin Transfer",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "TRAN"
    },
    "key": "chave@pix.com",
    "owner": {
      "document": "12ABC34501DE35",
      "name": "John Doe",
      "type": "NATURAL_PERSON",
      "tradeName": "John's Business"
    }
  },
  "feeCharge": {
    "applied": true,
    "calculationType": "segment",
    "fees": [
      {
        "amount": "1.50",
        "calculationType": "PERCENTAGE",
        "calculationValue": "1.5",
        "creditAccount": "01989f9e-6508-79f8-9540-835be49fbd0d",
        "feeLabel": "PIX_FEE"
      }
    ],
    "netAmount": "97.50",
    "totalAmount": "2.50"
  },
  "initiatedAt": "2024-01-15T10:30:00Z",
  "ledger": {
    "destinationOperationId": "550e8400-e29b-41d4-a716-446655440013",
    "revert": {
      "destinationOperationId": "550e8400-e29b-41d4-a716-446655440016",
      "sourceOperationId": "550e8400-e29b-41d4-a716-446655440015",
      "transactionId": "550e8400-e29b-41d4-a716-446655440014"
    },
    "sourceOperationId": "550e8400-e29b-41d4-a716-446655440012",
    "transactionId": "550e8400-e29b-41d4-a716-446655440011"
  },
  "metadata": {},
  "source": {
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "TRAN"
    },
    "key": "chave@pix.com",
    "owner": {
      "document": "12ABC34501DE35",
      "name": "John Doe",
      "type": "NATURAL_PERSON",
      "tradeName": "John's Business"
    }
  },
  "withdrawal": {
    "agentMode": "AGTEC",
    "withdrawalAmount": "50.00",
    "withdrawalServiceProvider": "12345678",
    "transactionAmount": "80.00"
  }
}

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

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

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

POST

transfers

cashout

process

Process a Pix Transfer

curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --data '<string>'

package main

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

func main() {

	url := "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process"

	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://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://plugin-pix-indirect.api.lerian.net/v1/transfers/cashout/process"

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

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

print(response.text)

{
  "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "amount": "100.50",
  "createdAt": "2024-01-15T10:30:15Z",
  "endToEndId": "E1234567820240101000001234567890",
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "initiationType": "KEY",
  "paymentType": "IMMEDIATE",
  "purpose": "TRANSFER",
  "status": "COMPLETED",
  "type": "CASHIN",
  "updatedAt": "2024-01-15T10:35:00Z",
  "urgency": "HIGH",
  "aliasId": "01989f9e-6508-79f8-9540-835be49fbd0e",
  "deletedAt": "<string>",
  "description": "Pix Cashin Transfer",
  "destination": {
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "TRAN"
    },
    "key": "chave@pix.com",
    "owner": {
      "document": "12ABC34501DE35",
      "name": "John Doe",
      "type": "NATURAL_PERSON",
      "tradeName": "John's Business"
    }
  },
  "feeCharge": {
    "applied": true,
    "calculationType": "segment",
    "fees": [
      {
        "amount": "1.50",
        "calculationType": "PERCENTAGE",
        "calculationValue": "1.5",
        "creditAccount": "01989f9e-6508-79f8-9540-835be49fbd0d",
        "feeLabel": "PIX_FEE"
      }
    ],
    "netAmount": "97.50",
    "totalAmount": "2.50"
  },
  "initiatedAt": "2024-01-15T10:30:00Z",
  "ledger": {
    "destinationOperationId": "550e8400-e29b-41d4-a716-446655440013",
    "revert": {
      "destinationOperationId": "550e8400-e29b-41d4-a716-446655440016",
      "sourceOperationId": "550e8400-e29b-41d4-a716-446655440015",
      "transactionId": "550e8400-e29b-41d4-a716-446655440014"
    },
    "sourceOperationId": "550e8400-e29b-41d4-a716-446655440012",
    "transactionId": "550e8400-e29b-41d4-a716-446655440011"
  },
  "metadata": {},
  "source": {
    "account": {
      "branch": "0001",
      "number": "123456789",
      "participant": "12345678",
      "type": "TRAN"
    },
    "key": "chave@pix.com",
    "owner": {
      "document": "12ABC34501DE35",
      "name": "John Doe",
      "type": "NATURAL_PERSON",
      "tradeName": "John's Business"
    }
  },
  "withdrawal": {
    "agentMode": "AGTEC",
    "withdrawalAmount": "50.00",
    "withdrawalServiceProvider": "12345678",
    "transactionAmount": "80.00"
  }
}

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

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

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

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Headers

X-Account-Id

string

Account ID (UUID format)

X-Purpose

string

Transaction purpose (TRANSFER, INSTANT_PAYMENT_REFUND, WITHDRAWAL for a Pix Saque charge, CHANGE for a Pix Troco charge). Defaults to TRANSFER.

Body

application/octet-stream

The body is of type file.

Response

Created

accountId

string

required

Example:

"01989f9e-6508-79f8-9540-835be49fbd0d"

amount

string

required

Example:

"100.50"

createdAt

string

required

Example:

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

endToEndId

string

required

Example:

"E1234567820240101000001234567890"

string

required

Example:

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

initiationType

enum<string>

required

Available options:

MANUAL,

KEY,

QR_CODE

Example:

"KEY"

paymentType

enum<string>

required

Available options:

IMMEDIATE,

SCHEDULED

Example:

"IMMEDIATE"

purpose

enum<string>

required

Available options:

TRANSFER,

INSTANT_PAYMENT_REFUND,

CHANGE,

WITHDRAWAL

Example:

"TRANSFER"

status

enum<string>

required

Available options:

CREATED,

PENDING,

PROCESSING,

COMPLETED,

FAILED,

REVERSED

Example:

"COMPLETED"

type

enum<string>

required

Available options:

CASHIN,

CASHOUT

Example:

"CASHIN"

updatedAt

string

required

Example:

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

urgency

enum<string>

required

Available options:

HIGH,

NORMAL

Example:

"HIGH"

aliasId

string

Example:

"01989f9e-6508-79f8-9540-835be49fbd0e"

deletedAt

string

description

string

Example:

"Pix Cashin Transfer"

destination

object

Show child attributes

feeCharge

object

Show child attributes

initiatedAt

string

Example:

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

ledger

object

Show child attributes

metadata

object

Show child attributes

source

object

Show child attributes

withdrawal

object

Show child attributes

DICT API

Claims API

MED · Infractions

MED · Fraud markers

MED · Refund requests

MED · Statistics

Transactions API

QR Codes API

Collections API

Funds Recovery API

Reconciliation API

Pix Automático API

Schedules API

Transaction Reports API

Transaction times

Webhooks API

Error handling

Process a Pix Transfer

Authorizations

Headers

Body

Response