Documentação - Documentação

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

Faz o envio de valores para uma chave externa, via Pix.

Permissão necessária: betpay:payout.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

Number

Valor a ser enviado.

Ex: 10.0

key

String

Chave Pix do recebedor. Telefone, Email, CPF, CNPJ ou Chave EVP. (Opcional, apenas uma chave ou os dados bancários devem ser informados)

Ex: 12345678912

bank_info

Object

Informações bancárias do recebedor (Opcional, apenas uma chave ou os dados bancários devem ser informados).

ispb

String

Código ISPB do banco do recebedor (o ISPB são os primeiros 8 digitos do cnpj da instituição).

Ex: 00100200

branch

String

Agência do recebedor.

Ex: 1234

account

String

Conta do recebedor. (Preencher apenas com números, o digito pode ser informado junto deste campo)

Ex: 567890

account_type

String
Enum: `checking_account`, `salary_account`, `savings_account`, `payment_account`

Tipo de conta do recebedor (checking_account - Conta corrente, salary_account - Conta salário, savings_account - Conta poupança, payment_account - Conta pagamento).

Ex: checking_account

name

String

Nome do recebedor.

Ex: John Doe

cpf

String

CPF do recebedor.

Ex: 12345678912

external_id

String

Identificador do cliente.

Ex: OUT123

validate_receiver

String

Documento para validar se a conta de destino é realmente do recebedor

Ex: 12345678912

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "amount": 10.0,
  "key": "12345678912",
  "bank_info": {
    "ispb": "00100200",
    "branch": "1234",
    "account": "567890",
    "account_type": "checking_account",
    "name": "John Doe",
    "cpf": "12345678912"
  },
  "external_id": "OUT123",
  "validate_receiver": "12345678912"
}

Response

200

Back

Busca operação de recebimento.

Forward

Busca operação de pagamento.