Skip to main content

Update payment provider

PATCH/payment-providers/{providerId}
Update an existing payment provider configuration

Parameters

providerIdpathrequired
string

Payment Provider ID

Request Body

namestringProvider display name
descriptionstringProvider description
status"active" | "inactive" | "pending_setup"Provider status
integrationServiceUrlstring (uri)Integration service URL
integrationServiceVersionstringIntegration service API version
configurationobjectProvider-specific configuration (merged with existing)
supportedPaymentTypes"online_card" | "online_bank_transfer" | "online_wallet" | "in_person_card" | "in_person_cash" | "bank_transfer" | "cheque"[]Supported payment types
capabilitiesobjectProvider capabilities (merged with existing)
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
priorityintegerProvider priority
feeStructureobjectFee structure
type*"percentage" | "fixed" | "percentage_plus_fixed"Fee structure type
percentagenumberPercentage fee
fixednumberFixed fee amount
currencystringCurrency for fixed fee
applicationFeeany
metadataobjectCustom metadata (merged with existing)

Response

Payment provider updated successfully

Code Samples
No code examples available for this operation.

Try It

Path Parameters
Payment Provider ID
Request Body
Provider display name
Provider description
Provider status
Integration service URL
Integration service API version
Provider-specific configuration (merged with existing)
Supported payment types
Provider capabilities (merged with existing)
Set as default provider
Provider priority
Fee structure
Custom metadata (merged with existing)