Docs

App Afiliados

Referência da API

...

Nesta página

Listar Pagamentos

get https://api.affiliates.iugu.com/payments

Retorna uma lista de pagamentos

Autorizações
oAuthClientCredentials
Flow type: clientCredentials
Token URL: https://identity.iugu.com/token
Scopes:
  • not:required - scopes are not in use

Parâmetros de Query

  • amount
    Number

    Valor total do pagamento

    Ex: 11.0

  • status
    String

    Status do pagamento

    Ex: pending

  • paid_at
    String

    Data em que o pagamento foi efetivamente realizado

    Ex: 2023-12-08T17:47:19.021Z

  • affiliate_id
    String

    ID do afiliado beneficiário do pagamento

    Ex: 1Y7fL0IL1aJjfSt3Dp4GNO

Parâmetros no Cabeçalho

  • workspace_id

    Obrigatório

    String

    Identificador do workspace

    Ex: 4fHECmQtLdROI4fDLWMiLd

Respostas
200
OK
success
Array of objects

id
String

Identificador único do pagamento

Ex: 14393a54-e266-4e4b-a0a8-e2b43d106790
amount
Number

Valor total do pagamento

Ex: 11.0
affiliate_id
String

ID do afiliado beneficiário do pagamento

Ex: 59c596f1-17a0-4aa4-83a4-4710f273f7ed
status
String

Status do pagamento ( "pending", "paid", "canceled" )

Ex: pending
paid_at
String

Data em que o pagamento foi efetivamente realizado

Ex: 2023-12-08T17:47:19.021Z
created_at
String

Data de criação do registro

Ex: 2023-12-08T17:47:19.021Z
updated_at
String

Data de atualização do registro

Ex: 2023-12-08T17:47:19.021Z
401
Unauthorized
status
String

Ex: 401
title
String

Ex: JWT VALIDATION ERROR
detail
String

Ex: Signature has expired
400
Bad Request
status
String

Ex: 400
title
String

Ex: Bad Request
detail
String

Ex: Bad Request
404
Not Found
message
String

Ex: Registro não encontrado.
500
Internal Server Error
status
String

Ex: 500
title
String

Ex: Internal Server Error
detail
String

Ex: Internal Error, try again later