Payment Execution API

Note

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

Endpoint Index

Action	Endpoint
Fetch Payment Provider Configuration	GET /payment-execution/{tenantLocator}/paymentProviders/{paymentServiceProvider}
Add Payment Provider Configuration	POST /payment-execution/{tenantLocator}/paymentProviders
Update Payment Provider Configuration	PATCH /payment-execution/{tenantLocator}/paymentProviders/{paymentServiceProvider}
Inactivate Payment Provider Configuration	PATCH /payment-execution/{tenantLocator}/paymentProviders/{paymentServiceProvider}/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 Configuration

fetchPaymentProviderConfiguration

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
paymentServiceProvider	path	Enum braintree | braintreeSandbox | stripe | stripeTest	required

Response:PaymentProviderConfiguration
Security Group:payment-providers   Permission:read

Add Payment Provider Configuration

addPaymentProviderConfiguration

POST /payment-execution/{tenantLocator}/paymentProviders

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:oneOf<BraintreeConfigurationRequest, StripeConfigurationRequest>
Response:PaymentProviderConfiguration
Security Group:payment-providers   Permission:write

Update Payment Provider Configuration

updatePaymentProviderConfiguration

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:oneOf<BraintreeConfigurationRequest, StripeConfigurationRequest>
Response:PaymentProviderConfiguration
Security Group:payment-providers   Permission:write

BraintreeConfigurationRequest

required
paymentProviderState Enum active | inactive
merchantId string
paymentServiceProvider Enum braintree | braintreeSandbox | stripe | stripeTest
privateKey string
publicKey string

StripeConfigurationRequest

required
paymentProviderState Enum active | inactive
paymentServiceProvider Enum braintree | braintreeSandbox | stripe | stripeTest
secretKey string

Inactivate Payment Provider Configuration

inactivatePaymentProviderConfiguration

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
paymentServiceProvider	path	Enum braintree | braintreeSandbox | stripe | stripeTest	required

Response:PaymentProviderConfiguration
Security Group:payment-providers   Permission:write

PaymentProviderConfiguration

no fields

Financial Instruments

Fetch Payment Execution Configuration for Financial Instrument

fetchPaymentExecutionConfigurationForFinancialInstrument

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
financialInstrumentLocator	path	string	required

Response:FinancialInstrumentConfigurationResponse
Security Group:financial-instruments   Permission:read

Add Payment Execution Configuration for Financial Instrument

addPaymentExecutionConfigurationForFinancialInstrument

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
financialInstrumentLocator	path	string	required

Request:FinancialInstrumentConfigurationRequest
Response:FinancialInstrumentConfigurationResponse
Security Group:financial-instruments   Permission:write

Update Payment Execution Configuration for Financial Instrument

updatePaymentExecutionConfigurationForFinancialInstrument

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
financialInstrumentLocator	path	string	required

Request:FinancialInstrumentConfigurationRequest
Response:FinancialInstrumentConfigurationResponse
Security Group:financial-instruments   Permission:write

FinancialInstrumentConfigurationRequest

required
offlinePaymentToken string
paymentServiceProvider Enum braintree | braintreeSandbox | stripe | stripeTest

optional
externalAccountNumber string?

FinancialInstrumentConfigurationResponse

required
paymentInstrumentLocator string
paymentServiceProvider Enum braintree | braintreeSandbox | stripe | stripeTest

optional
externalAccountNumber string?

See Also

• Payments API

• Payment Execution Service

• Autopay