Payment Execution API

The following endpoints are managed by the dedicated Payment Execution service in order to facilitate PCI-Compliance . Please review Socotra's PCI Compliance Statement for more information.

Action	Endpoint
Fetch Payment Provider Configurations	GET/payment-execution/{tenantLocator}/paymentProviders/list
Fetch Payment Provider Configuration	GET/payment-execution/{tenantLocator}/paymentProviders/{locator}
Add Payment Provider Configuration	POST/payment-execution/{tenantLocator}/paymentProviders
Update Payment Provider Configuration	PATCH/payment-execution/{tenantLocator}/paymentProviders/{locator}
Inactivate Payment Provider Configuration	PATCH/payment-execution/{tenantLocator}/paymentProviders/{locator}/inactivate
Fetch Payment Execution Configuration For Financial Instrument	GET/payment-execution/{tenantLocator}/financialInstruments/{financialInstrumentLocator}
Add Payment Execution Configuration For Financial Instrument	POST/payment-execution/{tenantLocator}/financialInstruments/{financialInstrumentLocator}
Update Payment Execution Configuration For Financial Instrument	PATCH/payment-execution/{tenantLocator}/financialInstruments/{financialInstrumentLocator}

Providers

Fetch Payment Provider Configurations

Fetch Payment Provider ConfigurationsfetchPaymentProviderConfigurations

GET/payment-execution/{tenantLocator}/paymentProviders/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`paymentServiceProvider`	query	`Enum? braintree \| braintreeSandbox \| stripe \| stripeTest`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponsePaymentProvider

Security Group:payment-providers

Permission:

list

ListPageResponsePaymentProvider

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`PaymentProvider[]`

Fetch Payment Provider Configuration

Fetch Payment Provider ConfigurationfetchPaymentProviderConfiguration

GET/payment-execution/{tenantLocator}/paymentProviders/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PaymentProvider

Security Group:payment-providers

Permission:

read

Add Payment Provider Configuration

Add Payment Provider ConfigurationaddPaymentProviderConfiguration

POST/payment-execution/{tenantLocator}/paymentProviders

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:oneOf<BraintreeConfigurationRequest,StripeConfigurationRequest>

Response:PaymentProvider

Security Group:payment-providers

Permission:

write

Update Payment Provider Configuration

Update Payment Provider ConfigurationupdatePaymentProviderConfiguration

PATCH/payment-execution/{tenantLocator}/paymentProviders/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:oneOf<BraintreeConfigurationRequest,StripeConfigurationRequest>

Response:PaymentProvider

Security Group:payment-providers

Permission:

write

BraintreeConfigurationRequest

Required properties

Property	Type	Description
`paymentProviderState`	`Enum active \| inactive`
`merchantId`	`string`
`paymentServiceProvider`	`Enum braintree \| braintreeSandbox \| stripe \| stripeTest`
`privateKey`	`string`
`publicKey`	`string`

StripeConfigurationRequest

Required properties

Property	Type	Description
`paymentProviderState`	`Enum active \| inactive`
`paymentServiceProvider`	`Enum braintree \| braintreeSandbox \| stripe \| stripeTest`
`secretKey`	`string`

Inactivate Payment Provider Configuration

Inactivate Payment Provider ConfigurationinactivatePaymentProviderConfigurationDeprecated

PATCH/payment-execution/{tenantLocator}/paymentProviders/{locator}/inactivate

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PaymentProvider

Security Group:payment-providers

Permission:

write

PaymentProvider

Required properties

Property	Type	Description
`locator`	`ulid`
`paymentProviderState`	`Enum active \| inactive`
`paymentServiceProvider`	`Enum braintree \| braintreeSandbox \| stripe \| stripeTest`

Financial Instruments

Fetch Payment Execution Configuration For Financial Instrument

Fetch Payment Execution Configuration For Financial InstrumentfetchPaymentExecutionConfigurationForFinancialInstrument

GET/payment-execution/{tenantLocator}/financialInstruments/{financialInstrumentLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`financialInstrumentLocator`	path	`ulid`	Yes

Response:FinancialInstrumentConfigurationResponse

Security Group:financial-instruments

Permission:

read

Add Payment Execution Configuration For Financial Instrument

Add Payment Execution Configuration For Financial InstrumentaddPaymentExecutionConfigurationForFinancialInstrument

POST/payment-execution/{tenantLocator}/financialInstruments/{financialInstrumentLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`financialInstrumentLocator`	path	`ulid`	Yes

Request:FinancialInstrumentConfigurationRequest

Response:FinancialInstrumentConfigurationResponse

Security Group:financial-instruments

Permission:

write

Update Payment Execution Configuration For Financial Instrument

Update Payment Execution Configuration For Financial InstrumentupdatePaymentExecutionConfigurationForFinancialInstrument

PATCH/payment-execution/{tenantLocator}/financialInstruments/{financialInstrumentLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`financialInstrumentLocator`	path	`ulid`	Yes

Request:FinancialInstrumentConfigurationRequest

Response:FinancialInstrumentConfigurationResponse

Security Group:financial-instruments

Permission:

write

FinancialInstrumentConfigurationRequest

Required properties

Property	Type	Description
`paymentProviderLocator`	`ulid`
`offlinePaymentToken`	`string`

Optional properties

Property	Type	Description
`externalAccountNumber`	`string?`

FinancialInstrumentConfigurationResponse

Required properties

Property	Type	Description
`paymentInstrumentLocator`	`ulid`
`paymentProviderLocator`	`ulid`

Optional properties

Property	Type	Description
`externalAccountNumber`	`string?`

Payment Execution API

Providers

Fetch Payment Provider Configurations

Fetch Payment Provider Configuration

Add Payment Provider Configuration

Update Payment Provider Configuration

Inactivate Payment Provider Configuration

Financial Instruments

Fetch Payment Execution Configuration For Financial Instrument

Add Payment Execution Configuration For Financial Instrument

Update Payment Execution Configuration For Financial Instrument

See Also

On this page