Skip to main content
Use this endpoint when you need the latest state of one payment after receiving a webhook, processing support tickets, or reconciling a specific charge.

Request

Method & Path

Required Headers

Path Parameters

string
required
The charge ID of the payin to retrieve.

Request Example


Response

200 - Success

Response Fields

string|null
Checkout reference for your internal reconciliation.
string
Charge ID of this payin.
string|null
Checkout that originated this payin.
string
Organization that owns the payin.
string
Raw charge status value (created, processing, succeeded, accepted, failed, expired, cancelled, refunded, partially_refunded, auto_refunded, underpaid, overpaid).
boolean|null
Whether this payin can currently be refunded.
string
Requested payment amount in currency.
string|null
Amount received so far.
string|null
Remaining amount still expected.
string
Payment currency code.
string|null
Processing fee amount, when available from quote data.
boolean|null
true when the merchant absorbs processing cost.
string|null
Source type for the payment when available.
string|null
Payment method used for the payin.
string|null
Payment rail used for the payin.
string|null
Origin channel (api, checkout, or other source).
string|null
Description attached to this payin.
object|null
Public metadata stored with the payin.
string|null
Human-readable message derived from payin status.
object|null
Customer info for this payin.
string|null
Customer full name.
string|null
Customer email address.
string
ISO 8601 creation timestamp.
string
ISO 8601 last update timestamp.
string|null
ISO 8601 completion timestamp when the payin is completed/accepted.

Error Responses

Cause: API key is missing, invalid, or revoked.Resolution: Send a valid key in the Authorization header.
Cause: The payin does not belong to your organization.Resolution: Use a key scoped to the payin owner organization.
Cause: No payin exists for the provided charge_id.Resolution: Verify the charge ID and environment, then retry.