Get Payment Program

šŸ”’

Required scope: partner-admin:read

The API credential calling this endpoint must be granted the partner-admin category with read or read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

Returns the payment program of the authenticated partner: its name, integration model,
lifecycle status and eligibility (allowed countries and currencies with their defaults).
The program is resolved from the credentials used to call the API, so a partner only
ever sees its own program.

An empty allowedCountries or allowedCurrencies list means the program does not
restrict that dimension. Use the lists to offer only valid countries when creating
organizations and only valid currencies when creating card accounts.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json