Transactions

Get Scheduled Payment

get/v1/scheduled-payments/{id}

Request

Base URL
https://conta-public-api.kiwify.com
URL
https://conta-public-api.kiwify.com/v1/scheduled-payments/{id}
Auth
API key in header x-access-id and API key in header X-PoP-Challenge and API key in header X-PoP-Format and API key in header X-PoP-Signature

Path parameters

idinteger required

Scheduled payment identifier

Response

Scheduled payment details retrieved

amount_in_centsinteger required

cancelled_atstring date-time nullable

Cancellation timestamp (UTC, RFC 3339), if cancelled.

created_atstring date-time required

Record creation timestamp (UTC, RFC 3339).

executed_atstring date-time nullable

Execution timestamp (UTC, RFC 3339). Null until processed.

idinteger required

receiverstring required

scheduled_datestring date required

Scheduled execution date (YYYY-MM-DD).

status'pending' | 'processing' | 'executed' | 'failed' | 'cancelled' required

transaction_idinteger nullable

typestring required

updated_atstring date-time nullable

Last update timestamp (UTC, RFC 3339).

Example response

{
  "cancelled_at": "2026-05-28T14:30:00Z",
  "created_at": "2026-05-28T14:30:00Z",
  "details": {
    "due_date": "2026-06-01"
  },
  "executed_at": "2026-05-28T14:30:00Z",
  "scheduled_date": "2026-06-01",
  "type": "pix",
  "updated_at": "2026-05-28T14:30:00Z"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.