Skip to main content
GET
/
v1
/
scheduled-payments
List Scheduled Payments
curl --request GET \
  --url https://conta-public-api.kiwify.com/v1/scheduled-payments \
  --header 'X-PoP-Challenge: <api-key>' \
  --header 'X-PoP-Format: <api-key>' \
  --header 'X-PoP-Signature: <api-key>' \
  --header 'x-access-id: <api-key>'
{
  "scheduled_payments": [
    {
      "amount_in_cents": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "id": 123,
      "receiver": "<string>",
      "scheduled_date": "2023-12-25",
      "status": "pending",
      "type": "pix",
      "executed_at": "2023-11-07T05:31:56Z",
      "transaction_id": 123
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

​
x-access-id
string
header
required

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

​
X-PoP-Challenge
string
header
required

Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5 minutes of server time.

​
X-PoP-Format
string
header
required

Must be 'service-account' for service account authentication

​
X-PoP-Signature
string
header
required

EdDSA signature of the request in base64 format. Signs: uri:method:body:timestamp

Query Parameters

​
cursor
string | null
​
limit
integer<int32> | null
Required range: x >= 0
​
status
null | enum<string>
Available options:
pending,
processing,
executed,
failed,
cancelled

Response

Scheduled payments retrieved

​
scheduled_payments
object[]
required
​
next_cursor
string | null