Skip to main content

Payment Methods API

Build your own payment-method picker without embedding @orchestrapay/react.

List payment methods for the default form​

GET /v202607/payment-methods resolves the tenant's default payment form using the same rules as embedded checkout.

Parameters​

This endpoint has no path or query parameters.

GET /v202607/payment-methods
import Orchestrapay, { ApiVersion } from '@orchestrapay/sdk';

const orchestrapay = new Orchestrapay('orch_sk_live_eu1_...', ApiVersion.v202607);
const methods = await orchestrapay.paymentMethods.list();

Response Parameters​

payment_formstring | null

The resolved payment form (pf_...). Null when the methods were derived directly from connectors.

payment_methodsarray

The configured payment methods in display order.

RESPONSE
{
"payment_form": "pf_eu1_...",
"payment_methods": [
  {
    "name": "souhoola",
    "title": "Souhoola",
    "category": "Buy Now Pay Later",
    "logo_url": "https://static.orchestrapay.com/payment-gateways/souhoola-logo.png",
    "favicon_url": "https://static.orchestrapay.com/payment-gateways/souhoola-favicon.png"
  }
]
}

List payment methods for a specific form​

GET /v202607/payment-methods/{payment_form} resolves the methods configured on the supplied pf_... form. The form must belong to the API key's tenant.

Path Parameters​

payment_formstring

The payment form reference (pf_...) whose methods should be returned.

GET /v202607/payment-methods/{payment_form}
import Orchestrapay, { ApiVersion } from '@orchestrapay/sdk';

const orchestrapay = new Orchestrapay('orch_sk_live_eu1_...', ApiVersion.v202607);
const methods = await orchestrapay.paymentMethods.list('pf_eu1_...');

Response Parameters​

The response parameters are the same as the default-form endpoint above.

RESPONSE
{
"payment_form": "pf_eu1_...",
"payment_methods": [
  {
    "name": "souhoola",
    "title": "Souhoola",
    "category": "Buy Now Pay Later",
    "logo_url": "https://static.orchestrapay.com/payment-gateways/souhoola-logo.png",
    "favicon_url": "https://static.orchestrapay.com/payment-gateways/souhoola-favicon.png"
  }
]
}