KIkiwify
Boleto Payments

Get Boleto Payment

Retrieves a single boleto payment by its ID for the authenticated account.

get/v1/boleto-payments/{id}

Request

  • Base URL
    https://conta-public-api.kiwify.com
  • URL
    https://conta-public-api.kiwify.com/v1/boleto-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

Boleto payment identifier

Response

Boleto payment retrieved successfully

amount_in_centsinteger nullable
barcode_linestring required
created_atstring date-time required

Payment creation timestamp (UTC, RFC 3339).

descriptionstring nullable
external_reference_idstring nullable
failed_messagestring nullable
idinteger required
scheduled_datestring date nullable

Scheduled execution date (YYYY-MM-DD). Null when executed immediately.

status'awaiting_approval' | 'pending' | 'processing' | 'success' | 'cancelled' | 'failed' required
tax_idstring required
transaction_idinteger nullable

Example response

{
  "created_at": "2026-05-28T14:30:00Z",
  "scheduled_date": "2026-06-01"
}

Changes

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