Create payment provider

POST/payment-providers

Create a new payment provider configuration

Request Body

accountIdstringAccount ID (optional - null for org-wide provider)

type*"stripe_connect" | "stripe_direct" | "adyen" | "square" | "paypal" | "cash" | "bank_transfer"Payment provider type

name*stringProvider display name

descriptionstringProvider description

integrationType"ticketlayer_pay" | "self_service"Integration type: ticketlayer_pay (managed by Ticketlayer, one per org) or self_service (default)

integrationServiceUrlstring (uri)Integration service URL (optional - uses default for type)

integrationServiceVersionstringIntegration service API version

configuration*objectProvider-specific configuration

supportedPaymentTypes*"online_card" | "online_bank_transfer" | "online_wallet" | "in_person_card" | "in_person_cash" | "bank_transfer" | "cheque"[]Supported payment types

▼capabilitiesobjectProvider capabilities (optional - uses defaults for type)

supportsInstantCapturebooleanSupports instant capture

supportsDelayedCapturebooleanSupports delayed capture

supportsRefundsbooleanSupports refunds

supportsPartialRefundsbooleanSupports partial refunds

requiresCustomerActionbooleanRequires customer action (3DS, etc.)

supportedCurrenciesstring[]Supported currencies

maxAmountnumberMaximum transaction amount

minAmountnumberMinimum transaction amount

isDefaultbooleanSet as default provider for this account/org

priorityintegerProvider priority (lower = higher priority)

▼feeStructureobjectFee structure for this provider

type*"percentage" | "fixed" | "percentage_plus_fixed"Fee structure type

percentagenumberPercentage fee

fixednumberFixed fee amount

currencystringCurrency for fixed fee

applicationFeeany

metadataobjectCustom metadata

Response

Payment provider created successfully

Code Samples

No code examples available for this operation.

Try It

Request Body

accountIdAccount ID (optional - null for org-wide provider)

type*Select...stripe_connectstripe_directadyensquarepaypalcashbank_transferPayment provider type

name*Provider display name

descriptionProvider description

integrationTypeSelect...ticketlayer_payself_serviceIntegration type: ticketlayer_pay (managed by Ticketlayer, one per org) or self_service (default)

integrationServiceUrlIntegration service URL (optional - uses default for type)

integrationServiceVersionIntegration service API version

configuration*{ "stripeConnectedAccountId": "acct_xxx" }Provider-specific configuration

supportedPaymentTypes*[ "online_card", "online_wallet" ]Supported payment types

capabilitiesProvider capabilities (optional - uses defaults for type)

isDefaultNot settruefalseSet as default provider for this account/org

priorityProvider priority (lower = higher priority)

feeStructureFee structure for this provider

applicationFee

metadata{ "environment": "production" }Custom metadata