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:api.payout

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 IDEMPOTENCY_KEY Type: string (Opcional) Chave de idempotencia, para garantir que a operação não seja executada mais de uma vez (validação pelo periodo de 30 minutos). 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

Operação de pagamento criada com sucesso

String

Código de identificação criado pela iugu

Ex: 16d8Tj4tFnLN6jySecOQBE

external_id

String

Código de identificação criado pelo cliente

Ex: OUT1234

amount

Number

Valor da operação de pagamento

Ex: 10.0

status

String
Enum: `processing`, `done`, `rejected`, `refunded`

Estado do pagamento: - processing: Pagamento em processamento - done: Pagamento efetivado - rejected: Pagamento rejeitado - refunded: Pagamento reembolsado

Ex: processing

key_type

String
Enum: `cpf`, `cnpj`, `email`, `phone`, `evp`

Tipo de chave pix do recebedor informado na criação do pagamento: - cpf - cnpj - email - phone - evp

Ex: cpf

key

String

Chave pix do recebedor informada na criação do pagamento

Ex: 123456789

end_to_end_id

String

Identificador da operação financeira junto aos bancos

Ex: E60701190202502271705DY5AAAAAAA

reject_reason

String

Motivo da rejeição do pagamento Referência: /betpay/payment_rejection

Ex: 123456789

created_at

String

Data e hora da criação do pagamento

Ex:

updated_at

String

Data e hora da última atualização do pagamento

Ex:

webhook_status_code

Integer

Código recebido como resposta do cliente na chamada do webhook cadastrado

Ex: 200

validate_receiver

String

Garante que a conta de destino é para o documento informado, sempre que este campo é informado o documento será validado

Ex: 123456789

payee_document_number

String

Documento do recebedor (mascarado)

Ex: 333.***.***-33

payee_name

String

Nome do recebedor

Ex: Jonh Doe

payee_bank_name

String

Nome do banco recebedor

Ex: BANCO DO BRASIL S.A.

payee_bank_account

String

Conta do recebedor

Ex: 567890

payee_bank_branch

String

Agência do recebedor

Ex: 1234

payee_bank_account_type

String

Tipo de conta do recebedor (checking_account, salary_account, savings_account, payment_account)

Ex: checking_account

payee_ispb

String

Código ispb do banco recebedor

Ex: 00000000

done_at

String

Data e hora da efetivação do pagamento

Ex: 2025-08-15T15:52:55.403Z

rejected_at

String

Data e hora da rejeição do pagamento

Ex: 2025-08-15T15:52:55.403Z

refunded_at"

String

Data e hora da reembolso do pagamento

Ex: 2025-08-15T15:52:55.403Z

refund_description"

String

Descrição do motivo do reembolso do pagamento

Ex: {"code":"MD06","description":"Devolução de pagamento solicitado pelo usuário recebedor;"}

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "id": "16d8Tj4tFnLN6jySecOQBE",
  "external_id": "OUT1234",
  "amount": 10.0,
  "status": "processing",
  "key_type": "cpf",
  "key": "123456789",
  "end_to_end_id": "E60701190202502271705DY5AAAAAAA",
  "reject_reason": "123456789",
  "created_at": "",
  "updated_at": "",
  "webhook_status_code": 200,
  "validate_receiver": "123456789",
  "payee_document_number": "333.***.***-33",
  "payee_name": "Jonh Doe",
  "payee_bank_name": "BANCO DO BRASIL S.A.",
  "payee_bank_account": "567890",
  "payee_bank_branch": "1234",
  "payee_bank_account_type": "checking_account",
  "payee_ispb": "00000000",
  "done_at": "2025-08-15T15:52:55.403Z",
  "rejected_at": "2025-08-15T15:52:55.403Z",
  "refunded_at\"": "2025-08-15T15:52:55.403Z",
  "refund_description\"": "{\"code\":\"MD06\",\"description\":\"Devolução de pagamento solicitado pelo usuário recebedor;\"}"
}

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"
}

409

Operação de pagamento já realizada

error

String

Mensagem de erro que ocorreu na requisição

Ex: Duplicate request

Example

1
2
3
{
  "error": "Duplicate request"
}

Back

Busca operação de recebimento.

Forward

Busca operação de pagamento.