Get Payment Options

Returns the payment options available for a specific source account. This endpoint is called by the Integration Hub before initiating a payment flow, so the frontend can determine how the user should select the destination beneficiary.

The main purpose of this endpoint is to communicate the beneficiary selection mode, which controls what kind of beneficiaries the user is allowed to choose as the destination of a payment originating from this account.

The connector must evaluate the source account (identified by accountId) and return the appropriate selection mode based on its own business rules, account type, regulatory constraints, or any other criteria relevant to the provider.

Beneficiary Selection Modes

The response contains a single field beneficiarySelectionMode which must be one of the following values:

  • ANY_BENEFICIARY_ANY_PROVIDER: No restrictions. The user can select any beneficiary from any BaaS provider. This is the most permissive mode and should be used when there are no limitations on who can receive payments from this account.

  • MERCHANT_ACCOUNTS_ANY_PROVIDER: The user can only select beneficiaries that correspond to the merchant's own Toqio accounts, but those accounts can be held at any BaaS provider. Use this mode when payments from this account must stay within the merchant's own accounts but can cross provider boundaries.

  • MERCHANT_ACCOUNTS_SAME_PROVIDER: The user can only select beneficiaries that correspond to the merchant's own Toqio accounts AND those accounts must be held at the same BaaS provider as the source account. This is the most restrictive mode and should be used when payments must stay within the same provider's infrastructure (e.g., for instant internal transfers or regulatory reasons).

How the Frontend Uses This

The Toqio frontend calls this endpoint through the Integration Hub before displaying the beneficiary selection step in the payment flow. Based on the returned mode, the frontend will filter the list of available beneficiaries accordingly, preventing the user from selecting an invalid destination.

Error Handling / Fallback Behavior

If this endpoint returns any error (4xx, 5xx, timeout, connection refused, etc.), the Integration Hub will treat it as if the connector returned ANY_BENEFICIARY_ANY_PROVIDER. This means the user will see all beneficiaries without restrictions. This fallback applies regardless of the specific error code or message. Connectors that do not wish to restrict beneficiary selection can simply not implement this endpoint at all.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the customer in the Toqio platform. This is the customer who owns the source account and is initiating the payment flow.

string
required

Unique identifier of the source account from which the payment will be made. The connector should evaluate this account to determine which beneficiary selection mode applies.

Responses

404

The specified customerId or accountId does not exist in the connector's system. Any error response will cause the Integration Hub to default to ANY_BENEFICIARY_ANY_PROVIDER.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json