Payment Execution API
We should put some sort of note about these endpoints being handled by a PCI-compliant service for sensitive data.
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
GET /payment-execution/{tenantLocator}/paymentProviders/listRequest 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
¶requiredlistCompleted booleanitems PaymentProvider[]
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
POST /payment-execution/{tenantLocator}/paymentProvidersRequest Parameters:
| Name | Position | Type | Required | 
|---|---|---|---|
| tenantLocator | path | uuid | required | 
Request:oneOf<BraintreeConfigurationRequest, StripeConfigurationRequest>
Response:PaymentProvider
Security Group:payment-providers   Permission:write
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
¶requiredpaymentProviderState Enum active | inactivemerchantId stringpaymentServiceProvider Enum braintree | braintreeSandbox | stripe | stripeTestprivateKey stringpublicKey string
StripeConfigurationRequest
¶requiredpaymentProviderState Enum active | inactivepaymentServiceProvider Enum braintree | braintreeSandbox | stripe | stripeTestsecretKey string
This endpoint will be removed in a future release.
PATCH /payment-execution/{tenantLocator}/paymentProviders/{locator}/inactivateRequest Parameters:
| Name | Position | Type | Required | 
|---|---|---|---|
| tenantLocator | path | uuid | required | 
| locator | path | string | required | 
Response:PaymentProvider
Security Group:payment-providers   Permission:write
PaymentProvider
¶requiredlocator stringpaymentProviderState Enum active | inactivepaymentServiceProvider 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 | 
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 | 
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 | 
Security Group:financial-instruments   Permission:write
FinancialInstrumentConfigurationRequest
¶requiredpaymentProviderLocator stringofflinePaymentToken stringoptionalexternalAccountNumber string?
FinancialInstrumentConfigurationResponse
¶requiredpaymentInstrumentLocator stringpaymentProviderLocator stringoptionalexternalAccountNumber string?