API atual/Referência completa/Pagar.me, chargebacks e disputas

Pagar.me: transferência automática

Lê e altera a periodicidade com que o Pagar.me transfere o saldo do seller para a conta bancária.

Duas rotas sobre a mesma configuração do recebedor no Pagar.me. Mesmos pré-requisitos das rotas de saldo e recebíveis: módulo pagarme, privilégio financeiro e recebedor vinculado.

Ver configuração de transferência

A transferência é o saque automático do saldo disponível no Pagar.me para a conta bancária do seller. Esta rota lê a configuração atual.

GET/api/v1/vendor/pagarme/transferSeller

Como o Pagar.me transfere o dinheiro do seller

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/pagarme/transfer" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Configuração

json

{
  "transfer_enabled": true,
  "transfer_interval": "Weekly",
  "transfer_day": 5
}

Campos da resposta

transfer_enabledboolean

Transferência automática ligada.

transfer_intervalstring

Periodicidade configurada no Pagar.me.

transfer_dayinteger

Dia da transferência.

Erros

Status	Quando	Corpo de exemplo
409	O seller ainda não tem recebedor (recipient) cadastrado no Pagar.me.	`{"error":"pagarme_recipient_missing","detail":"pagarme: vendor has no recipient"}`
503	A loja não configurou a chave de API do Pagar.me.	`{"error":"pagarme_api_key_missing","detail":"pagarme: api key not configured"}`
502	O Pagar.me recusou ou falhou. O trecho da resposta dele vai em `detail`.	`{"error":"pagarme_upstream","detail":"pagarme: /payables returned 401: ..."}`
401	Token ausente, inválido, expirado ou revogado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador), ou o usuário não está vinculado a nenhum seller.	`{"error":"insufficient permissions"}`
403	Sub-conta do seller sem nenhum dos privilégios financeiro (a lista completa vem em `privilege_required_any`; o exemplo está cortado). O dono da loja passa sempre.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_financial","vendor_view_financial"]}`
403	O módulo `pagarme` está desligado nesta loja.	`{"error":"module_disabled","module":"pagarme"}`

Alterar configuração de transferência

Atualiza a configuração no Pagar.me e devolve o valor relido de lá. É uma substituição completa dos três campos: o que você não enviar vai como zero/falso.

PUT/api/v1/vendor/pagarme/transferSeller

Alterar a transferência automática

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).

Content-Typestringobrigatório

application/json.

Corpo da requisição

transfer_enabledbooleanobrigatório

Liga ou desliga a transferência automática.

transfer_intervalstringobrigatório

Periodicidade, repassada ao Pagar.me sem validação nem conversão. Consulte a documentação do Pagar.me para os valores aceitos.

transfer_dayinteger

Dia da transferência (dia da semana ou do mês, conforme a periodicidade). Se omitido, vai 0.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/pagarme/transfer" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "transfer_enabled": true,
  "transfer_interval": "Weekly",
  "transfer_day": 5
}'

Resposta

200Configuração atualizada

json

{
  "transfer_enabled": true,
  "transfer_interval": "Weekly",
  "transfer_day": 5
}

Campos da resposta

transfer_enabledboolean

Transferência automática ligada.

transfer_intervalstring

Periodicidade configurada no Pagar.me.

transfer_dayinteger

Dia da transferência.

Erros

Status	Quando	Corpo de exemplo
400	Corpo que não é JSON.	`{"error":"invalid json","detail":"invalid character..."}`
409	O seller ainda não tem recebedor (recipient) cadastrado no Pagar.me.	`{"error":"pagarme_recipient_missing","detail":"pagarme: vendor has no recipient"}`
503	A loja não configurou a chave de API do Pagar.me.	`{"error":"pagarme_api_key_missing","detail":"pagarme: api key not configured"}`
502	O Pagar.me recusou ou falhou. O trecho da resposta dele vai em `detail`.	`{"error":"pagarme_upstream","detail":"pagarme: /payables returned 401: ..."}`
401	Token ausente, inválido, expirado ou revogado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador), ou o usuário não está vinculado a nenhum seller.	`{"error":"insufficient permissions"}`
403	Sub-conta do seller sem nenhum dos privilégios financeiro (a lista completa vem em `privilege_required_any`; o exemplo está cortado). O dono da loja passa sempre.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_financial","vendor_view_financial"]}`
403	O módulo `pagarme` está desligado nesta loja.	`{"error":"module_disabled","module":"pagarme"}`

Veja também

API atual/Referência completa/Pagar.me, chargebacks e disputas

Pagar.me: transferência automática

Lê e altera a periodicidade com que o Pagar.me transfere o saldo do seller para a conta bancária.

Duas rotas sobre a mesma configuração do recebedor no Pagar.me. Mesmos pré-requisitos das rotas de saldo e recebíveis: módulo pagarme, privilégio financeiro e recebedor vinculado.

Ver configuração de transferência

A transferência é o saque automático do saldo disponível no Pagar.me para a conta bancária do seller. Esta rota lê a configuração atual.

GET/api/v1/vendor/pagarme/transferSeller

Como o Pagar.me transfere o dinheiro do seller

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/pagarme/transfer" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Configuração

json

{
  "transfer_enabled": true,
  "transfer_interval": "Weekly",
  "transfer_day": 5
}

Campos da resposta

transfer_enabledboolean

Transferência automática ligada.

transfer_intervalstring

Periodicidade configurada no Pagar.me.

transfer_dayinteger

Dia da transferência.

Erros

Status	Quando	Corpo de exemplo
409	O seller ainda não tem recebedor (recipient) cadastrado no Pagar.me.	`{"error":"pagarme_recipient_missing","detail":"pagarme: vendor has no recipient"}`
503	A loja não configurou a chave de API do Pagar.me.	`{"error":"pagarme_api_key_missing","detail":"pagarme: api key not configured"}`
502	O Pagar.me recusou ou falhou. O trecho da resposta dele vai em `detail`.	`{"error":"pagarme_upstream","detail":"pagarme: /payables returned 401: ..."}`
401	Token ausente, inválido, expirado ou revogado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador), ou o usuário não está vinculado a nenhum seller.	`{"error":"insufficient permissions"}`
403	Sub-conta do seller sem nenhum dos privilégios financeiro (a lista completa vem em `privilege_required_any`; o exemplo está cortado). O dono da loja passa sempre.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_financial","vendor_view_financial"]}`
403	O módulo `pagarme` está desligado nesta loja.	`{"error":"module_disabled","module":"pagarme"}`

Alterar configuração de transferência

Atualiza a configuração no Pagar.me e devolve o valor relido de lá. É uma substituição completa dos três campos: o que você não enviar vai como zero/falso.

PUT/api/v1/vendor/pagarme/transferSeller

Alterar a transferência automática

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).

Content-Typestringobrigatório

application/json.

Corpo da requisição

transfer_enabledbooleanobrigatório

Liga ou desliga a transferência automática.

transfer_intervalstringobrigatório

Periodicidade, repassada ao Pagar.me sem validação nem conversão. Consulte a documentação do Pagar.me para os valores aceitos.

transfer_dayinteger

Dia da transferência (dia da semana ou do mês, conforme a periodicidade). Se omitido, vai 0.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/vendor/pagarme/transfer" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "transfer_enabled": true,
  "transfer_interval": "Weekly",
  "transfer_day": 5
}'

Resposta

200Configuração atualizada

json

{
  "transfer_enabled": true,
  "transfer_interval": "Weekly",
  "transfer_day": 5
}

Campos da resposta

transfer_enabledboolean

Transferência automática ligada.

transfer_intervalstring

Periodicidade configurada no Pagar.me.

transfer_dayinteger

Dia da transferência.

Erros

Status	Quando	Corpo de exemplo
400	Corpo que não é JSON.	`{"error":"invalid json","detail":"invalid character..."}`
409	O seller ainda não tem recebedor (recipient) cadastrado no Pagar.me.	`{"error":"pagarme_recipient_missing","detail":"pagarme: vendor has no recipient"}`
503	A loja não configurou a chave de API do Pagar.me.	`{"error":"pagarme_api_key_missing","detail":"pagarme: api key not configured"}`
502	O Pagar.me recusou ou falhou. O trecho da resposta dele vai em `detail`.	`{"error":"pagarme_upstream","detail":"pagarme: /payables returned 401: ..."}`
401	Token ausente, inválido, expirado ou revogado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador), ou o usuário não está vinculado a nenhum seller.	`{"error":"insufficient permissions"}`
403	Sub-conta do seller sem nenhum dos privilégios financeiro (a lista completa vem em `privilege_required_any`; o exemplo está cortado). O dono da loja passa sempre.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_financial","vendor_view_financial"]}`
403	O módulo `pagarme` está desligado nesta loja.	`{"error":"module_disabled","module":"pagarme"}`