Docs
Começando
Anexos
API
get https://betpay.iugu.com/api/v1/payin/external_id/{external_id}

Busca operação de recebimento.

Busca operação de recebimento pelo identificador do cliente.

Permissão necessária: betpay:payin.search

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

Path variables

external_id

Required

Type: string

Headers

WORKSPACE_ID

Type: string

ID do workspace

Ex: 1D81KhKbYuVq9505Bz4Nk9

Response

200

Operação de recebimento encontrada

id
String

Código de identificação criado pela iugu

Ex: 16d8Tj4tFnLN6jySecOQBE
amount
Number

Valor da operação de recebimento

Ex: 10.0
payer_name
String

Nome do pagador da operação de recebimento

Ex: John Doe
payer_fiscal
String

Documento do pagador da operação de recebimento

Ex: 123456789
status
String
Enum: `pending`, `paid`, `partially_paid`, `refunded`, `canceled`

Estado do recebimento: - pending: Pendente de pagamento - paid: Pago - partially_paid: Pagamento parcial - refunded: Reembolsado - canceled: Recebimento cancelado

Ex: pending
created_at
String

Data e hora da criação do recebimento

Ex:

updated_at
String

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

Ex:

end_to_end_id
String

Identificador da operação financeira junto aos bancos

Ex: E60701190202502271705DY5AAAAAAA
webhook_status_code
Integer

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

Ex: 200
refund_end_to_end_id
String

Identificador da operação financeira de reembolso junto aos bancos

Ex: D15111975202502210712320466AAAAA
refund_at
String

Data e hora em que o reembolso foi realizado

Ex:

paid_at
String

Data e hora em que o pagamento foi efetivado

Ex:

canceled_at
String

Data e hora em que o recebimento foi cancelado

Ex:

read_at
String

Data e hora em que o QRCode foi lido

Ex:

external_id
String

Código de identificação criado pelo cliente

Ex: IN1234
Example 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
  "id": "16d8Tj4tFnLN6jySecOQBE",
  "amount": 10.0,
  "payer_name": "John Doe",
  "payer_fiscal": "123456789",
  "status": "pending",
  "created_at": "",
  "updated_at": "",
  "end_to_end_id": "E60701190202502271705DY5AAAAAAA",
  "webhook_status_code": 200,
  "refund_end_to_end_id": "D15111975202502210712320466AAAAA",
  "refund_at": "",
  "paid_at": "",
  "canceled_at": "",
  "read_at": "",
  "external_id": "IN1234"
}

404

Operação com o identificador externo não encontrada

Back

Cria um QRCode Pix para o recebimento de valores.

Forward

Busca operação de recebimento.