Pular para o conteúdo principal

Como usar a API para Transferir Valores entre Contas?

info

Para a utilização dessa funcionalidade é necessário possuir a funcionalidade BETA

Para transferir valores entre suas contas você por utilizar o endpoint /api/v1/transfer da API.

Os campos obrigatórios para criar uma transferência entre contas são os seguintes:

  • value: O valor em centavos a ser transferido.
  • fromPixKey: A chave pix da conta de origem
  • toPixKey: A chave pix da conta de destino

Exemplo

O body da sua requisição será semelhante a este exemplo:

{
"value": 100,
"fromPixKey": "from@openpix.com.br",
"toPixKey": "to@openpix.com.br"
}

O valor do campo value é o valor desejado para a transferência em centavos.

Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, será retornado os seguintes campos:

{
"transaction": {
"value": 100,
"time": "2023-06-22T15:33:27.165Z",
"correlationID": "c782e0ac-833d-4a89-9e73-9b60b2b41d3a"
}
}

Exemplos em código

  curl 'https://api.openpix.com.br/api/v1/transfer' -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "user-agent: node-fetch" \
--data-binary '{"value": 100, "fromPixKey": "from@openpix.com.br", "toPixKey": "to@openpix.com.br"}'