Documentação - Documentação

post https://betpay.iugu.com/api/v1/transfer

Transfere o saldo para outro workspace.

Permissão necessária: betpay:transfer.create

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Headers
WORKSPACE_ID Type: string ID do workspace Ex: 1D81KhKbYuVq9505Bz4Nk9

Body

Content Type: application/json

amount

Required

Number

Valor a ser transferido.

Ex: 10.0

receiver_workspace_id

Required

String

Id do workspace a receber.

external_id

String

Identificador da operação.

Example

1
2
3
4
5
{
  "amount": 10.0,
  "receiver_workspace_id": "<RECEIVER_WORKSPACE_ID>",
  "external_id": "<EXTERNAL_ID>"
}

Response

200

Transferência realizada com sucesso

String

Código de identificação criado pela iugu

Ex: 16d8Tj4tFnLN6jySecOQBE

from_workspace_id

String

Workspace que realizou a transferência

Ex: aa82a0e6-4e31-4289-b233-5738v8d897f0

to_workspace_id

String

Workspace que recebeu a transferência

Ex: ab32a0e6-4e31-4289-b233-5738v8d897f2

amount

Number

Valor transferido

Ex: 10.0

external_id

String

Identificador da operação

Ex: TRANSFER5543

created_at

String

Data e hora da criação da transferência

Ex:

updated_at

String

Data e hora da última atualização da transferência

Ex:

Example

1
2
3
4
5
6
7
8
9
{
  "id": "16d8Tj4tFnLN6jySecOQBE",
  "from_workspace_id": "aa82a0e6-4e31-4289-b233-5738v8d897f0",
  "to_workspace_id": "ab32a0e6-4e31-4289-b233-5738v8d897f2",
  "amount": 10.0,
  "external_id": "TRANSFER5543",
  "created_at": "",
  "updated_at": ""
}

400

Houve um erro na validação da requisição

message

String

Lista de erros que ocorreram na requisição

Ex: Campo chave é obrigatório

Example

1
2
3
{
  "message": "Campo chave é obrigatório"
}

Back

Retorna o saldo do workspace.