Skip to main content
GET
Get payment channel
Retrieve one active payment channel by its id. Returns 404 CHANNEL_NOT_FOUND if the channel does not exist, belongs to another account, or has been deleted.

Authorizations

Authorization
string
header
required

Paste your PalPluss API key in the username field and leave the password field empty — it is ignored.

Get your key from console → Settings → API Keys (starts with pk_live_ or pk_test_).

In your own code, send the key directly: Authorization: Basic YOUR_API_KEY

Path Parameters

id
string<uuid>
required

The channel ID.

Response

Payment channel retrieved successfully.

success
boolean
required
Example:

true

data
object
required

Response payload. Shape varies by endpoint.

requestId
string<uuid>
required

Unique identifier for this API request. Include in support tickets.

Example:

"c1b2a3d4-e5f6-7890-abcd-ef1234567890"