Docs Afiliados

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

Respostas
200
OK
data
Array

id
String

Identificador único do pagamento

Ex: 14393a54-e266-4e4b-a0a8-e2b43d106790
type
String

Tipo de recurso ("payment")

Ex: payment
attributes
Object

amount
Number

Valor total do pagamento

Ex: 11.0
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: 59c596f1-17a0-4aa4-83a4-4710f273f7ed
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
relationships
Object

affiliate
Object

data
Object

id
String

Ex: 4054c1d4-2ed3-4176-bd99-b0fc5b5a7f58
type
String

Ex: affiliate
meta
Object

total
Integer

Total de pagamentos

Ex: 1
links
Object

self
String

URL da página atual

Ex: https://affiliates.iugu.com/api/payments
current
String

URL da página atual

Ex: https://affiliates.iugu.com/api/payments?page[number]=1
400
Bad Request
errors
Array

status
String

Ex: 400
source
Null

title
String

Ex: Bad Request
detail
Null

404
Not Found
errors
Array

status
String

Ex: 404
source
Null

title
String

Ex: Not Found
detail
Null

500
Internal Server Error
errors
Array

status
String

Ex: 500
source
Null

title
String

Ex: Internal Server Error
detail
Null