Payment Execution API

Note

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.

Endpoint Index

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

fetchPaymentProviderConfigurations

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
paymentServiceProvider	query	Enum? braintree | braintreeSandbox | stripe | stripeTest	optional
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponsePaymentProvider
Security Group:payment-providers   Permission:list

ListPageResponsePaymentProvider

required
listCompleted boolean
items PaymentProvider[]

Fetch Payment Provider Configuration

fetchPaymentProviderConfiguration

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

Request Parameters:

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

Response:PaymentProvider
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:PaymentProvider
Security Group:payment-providers   Permission:write

Update Payment Provider Configuration

updatePaymentProviderConfiguration

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

Request Parameters:

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

Request:oneOf<BraintreeConfigurationRequest, StripeConfigurationRequest>
Response:PaymentProvider
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

Deprecated

inactivatePaymentProviderConfiguration

This endpoint will be removed in a future release.

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

Request Parameters:

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

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

PaymentProvider

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

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
paymentProviderLocator string
offlinePaymentToken string

optional
externalAccountNumber string?

FinancialInstrumentConfigurationResponse

required
paymentInstrumentLocator string
paymentProviderLocator string

optional
externalAccountNumber string?

See Also

• Payments API

• Payment Execution Service

• Autopay