Skip to main content
GET
Retrieve a payment

Authorizations

Authorization
string
header
required

Bearer credential for the public API: a live COPE API key (ck_live_*; keys issued earlier as cope_sk_live_* keep working). Dashboard sign-in tokens are not accepted.

Path Parameters

id
string
required

id public identifier.

Pattern: ^py_[A-Za-z0-9]{8,32}$
Example:

"py_A1b2C3d4E5f6"

Query Parameters

status
string

Which sale statuses to return: trial, pending, succeeded, failed, or several separated by commas (pending,failed). trial: a free trial started, nothing charged yet. pending: the charge is processing. succeeded: paid. failed: the charge did not go through. Without it only succeeded sales whose funds availability date is known are returned, exactly as before this parameter existed; named, it filters on status alone, so succeeded also returns a sale whose funds date is not known yet. An unknown name or an empty element is refused with 422.

Response

Successful response

data
object
required