Organization API: Customer Portal: Payment config

The 1 Organization API operations for payment config.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/portal/payment-config`	Get portal payment config

Get portal payment config

Section titled Get portal payment config

GET /api/v1/orgs/{org_slug}/portal/payment-config

Return the gateway accounts that can take a payment for the given pay currency, each merged with the adapter's non-secret client config (public_config: Stripe publishable key, PayPal client id, Square application and location ids) needed to render embedded UIs.

A card account whose adapter is not in card_adapters is left out, so a frontend that cannot draw Square's card form never sees a Square account. For a Square account public_config.location_id is the location of your store's brand, which is what the customer's statement shows.

Each account also has local_methods: the tokens of the payment methods made for the customer's country (such as ideal for the Netherlands) that it can show in currency. It is empty for an account that shows none, for an account that is not Stripe, and until we have read the account's payment method settings, which this route never waits for. A Stripe account that can show one is listed before one that cannot, unless your routing profile names its accounts.

Parameters

Section titled Parameters

Name	In	Type	Required	Description
`org_slug`	path	string	yes
`currency`	query	string	no
`country`	query	string	no
`card_adapters`	query	string or null	no	The card forms your frontend can draw, as a comma list of `stripe` and `square`. Defaults to `stripe`, so a frontend with no Square form keeps getting Stripe accounts. Send `stripe,square` once it can draw Square's card form: the quote then names whichever account your routing rules choose, and its `adapter` says which form to draw.

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.