Skip to main content
GET
Claim funds

Authorizations

Authorization
string
header
required

Your secret key as a Bearer token. The key prefix selects the environment: sk_test_... (staging) or sk_live_... (production); a key on the wrong host is refused with 403 Unauthorized Access. Each key is limited to 10 requests per minute (429 beyond that) and, on production, to the IP addresses on your dashboard allowlist when one is configured.

Headers

customer-id
string

The merchant customer this request acts on behalf of. Omit it to act as your own business account (only a business-type account can sell on its own behalf).

Path Parameters

paymentToken
string
required

The escrow's payment token (e.g. PY_8AB12C9D3045).

Response

Funds claimed.

status
integer
Example:

200

message
string
Example:

"Operation successful"

data
object