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

Retorna uma lista de pagamentos

Sem ações implementadas definidas

Request

Query params

amount

Type: number

Valor total do pagamento

Ex: 11.0

status

Type: string

Status do pagamento

Ex: pending

paid_at

Type: string

Data em que o pagamento foi efetivamente realizado

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

affiliate_id

Type: string

ID do afiliado beneficiário do pagamento

Ex: 1Y7fL0IL1aJjfSt3Dp4GNO

Headers

workspace_id

Required

Type: string

Identificador do workspace

Ex: 4fHECmQtLdROI4fDLWMiLd

Response

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

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "success": [
    {
      "id": "14393a54-e266-4e4b-a0a8-e2b43d106790",
      "amount": 11.0,
      "affiliate_id": "59c596f1-17a0-4aa4-83a4-4710f273f7ed",
      "status": "pending",
      "paid_at": "2023-12-08T17:47:19.021Z",
      "created_at": "2023-12-08T17:47:19.021Z",
      "updated_at": "2023-12-08T17:47:19.021Z"
    }
  ]
}

401

Unauthorized

status
String

Ex: 401

title
String

Ex: JWT VALIDATION ERROR

detail
String

Ex: Signature has expired

Example
1
2
3
4
5
{
  "status": "401",
  "title": "JWT VALIDATION ERROR",
  "detail": "Signature has expired"
}

400

Bad Request

status
String

Ex: 400

title
String

Ex: Bad Request

detail
String

Ex: Bad Request

Example
1
2
3
4
5
{
  "status": "400",
  "title": "Bad Request",
  "detail": "Bad Request"
}

404

Not Found

message
String

Ex: Registro não encontrado.

Example
1
2
3
{
  "message": "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

Example
1
2
3
4
5
{
  "status": "500",
  "title": "Internal Server Error",
  "detail": "Internal Error, try again later"
}