Spreedly
Payment gateway and processing integration platform
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://core.spreedly.com/v1 | link | — | — | — |
Actions (74)
Environments · 14
- Create access secretPOST /v1/environments/{environment_key}/access_secrets.{format}
Create an access secret for API access in an environment.
documented - Create access secretPOST /v1/environments/{environment_key}/access_secrets.{format}
Create an access secret for API access in an environment.
documented - Create environmentPOST /v1/environments.{format}
Create a new Spreedly environment.
documented - Create environmentPOST /v1/environments.{format}
Create an environment.
documented - List access secretsGET /v1/environments/{environment_key}/access_secrets.{format}
List access secrets for an environment.
documented - List access secretsGET /v1/environments/{environment_key}/access_secrets.{format}
List all access secrets for an environment.
documented - List environmentsGET /v1/environments.{format}
List all environments.
documented - List environmentsGET /v1/environments.{format}
Retrieve all environments in the authenticated organization.
documented - Show access secretGET /v1/environments/{environment_key}/access_secrets/{access_secret_key}.{format}
Show the access secret details.
documented - Show access secretGET /v1/environments/{environment_key}/access_secrets/{access_secret_key}.{format}
Show the access secret details.
documented - Show environmentGET /v1/environments/{environment_key}.{format}
Retrieve details for a specific environment.
documented - Show environmentGET /v1/environments/{environment_key}.{format}
Show an environment.
documented - Update environmentPUT /v1/environments/{environment_key}.{format}
Update an environment.
documented - Update environmentPUT /v1/environments/{environment_key}.{format}
Update an environment's non-sensitive attributes.
documented
Transactions · 13
- Authorize on transactionPOST /v1/transactions/{transaction_token}/authorize.{format}
Authorize a saved transaction by its token.
documented - Authorize transactionPOST /v1/transactions/authorize.{format}
Create an authorization transaction using a payment method token.
documented - Capture transactionPOST /v1/transactions/{transaction_token}/capture.{format}
Capture an authorized transaction.
documented - Complete transactionPOST /v1/transactions/{transaction_token}/complete.{format}
Complete an offsite or ongoing transaction.
documented - Confirm transactionPOST /v1/transactions/{transaction_token}/confirm.{format}
Confirm a pending offsite purchase/authorization.
documented - Credit transactionPOST /v1/transactions/{transaction_token}/credit.{format}
Credit a transaction.
documented - List transactionsGET /v1/transactions.{format}
Retrieve an ordered list of transactions in the authenticated environment.
documented - Purchase on transactionPOST /v1/transactions/{transaction_token}/purchase.{format}
Purchase using a saved transaction.
documented - Purchase transactionPOST /v1/transactions/purchase.{format}
Create a purchase transaction using a payment method token.
documented - Show transactionGET /v1/transactions/{transaction_token}.{format}
Retrieve a specific transaction.
documented - Show transaction transcriptGET /v1/transactions/{transaction_token}/transcript
Retrieve transcript details of a transaction.
documented - Verify transactionPOST /v1/transactions/verify.{format}
Verify a payment method or card data via Spreedly's verifier.
documented - Void transactionPOST /v1/transactions/{transaction_token}/void.{format}
Void a transaction.
documented
Gateways · 9
- Create test gatewayPOST /v1/gateways.{format}
Create a test gateway instance in Spreedly.
documented - List gateway transactionsGET /v1/gateways/{gateway_token}/transactions.{format}
Retrieve a list of transactions executed against a specific gateway.
documented - List gateway transactionsGET /v1/gateways/{gateway_token}/transactions.{format}
Retrieve a list of transactions executed against a specific gateway.
documented - List gatewaysGET /v1/gateways.{format}
List gateways provisioned in the current environment.
documented - List supported gatewaysGET /v1/gateways_options.{format}
Return the set of gateway types Spreedly can connect to.
documented - Purchase via gatewayPOST /v1/gateways/{gateway_token}/purchase.{format}
Execute a purchase through the specified gateway.
documented - Redact gatewayPUT /v1/gateways/{gateway_token}/redact.{format}
Redact a gateway's credentials and deactivate the gateway.
documented - Show gatewayGET /v1/gateways/{gateway_token}.{format}
Retrieve details for a provisioned gateway.
documented - Verify gatewayPOST /v1/gateways/{gateway_token}/verify.{format}
Verify a gateway by performing a test transaction against it.
documented
Merchant Profiles · 7
- Create merchant profilePOST /v1/merchant_profiles.{format}
Create a merchant profile.
documented - List merchant profilesGET /v1/merchant_profiles.{format}
List merchant profiles.
documented - List merchant profilesGET /v1/merchant_profiles.{format}
List merchant profiles.
documented - Show merchant profileGET /v1/merchant_profiles/{merchant_profile_token}.{format}
Show a merchant profile.
documented - Show merchant profileGET /v1/merchant_profiles/{merchant_profile_token}.{format}
Show a merchant profile.
documented - Update merchant profilePUT /v1/merchant_profiles/{merchant_profile_token}.{format}
Update a merchant profile.
documented - Update merchant profilePUT /v1/merchant_profiles/{merchant_profile_token}.{format}
Update a merchant profile.
documented
Sub Merchants · 7
- Create sub-merchantPOST /v1/sub_merchants.{format}
Create a new sub-merchant.
documented - Create sub-merchantPOST /v1/sub_merchants.{format}
Create a sub-merchant.
documented - List sub-merchantsGET /v1/sub_merchants.{format}
List sub-merchants.
documented - List sub-merchantsGET /v1/sub_merchants.{format}
List sub-merchants in the environment.
documented - Show sub-merchantGET /v1/sub_merchants/{sub_merchant_token}.{format}
Show a sub-merchant's details.
documented - Update sub-merchantPUT /v1/sub_merchants/{sub_merchant_token}.{format}
Update a sub-merchant.
documented - Update sub-merchantPUT /v1/sub_merchants/{sub_merchant_token}.{format}
Update a sub-merchant's details.
documented
Receivers · 6
- Create receiverPOST /v1/receivers.{format}
Provision a new payment method receiver.
documented - List receiversGET /v1/receivers.{format}
List receivers provisioned in the environment.
documented - List supported receiversGET /v1/receivers_options.{format}
List publicly available payment method receivers Spreedly can deliver to.
documented - Redact receiverPUT /v1/receivers/{receiver_token}/redact.{format}
Redact a receiver and remove sensitive data.
documented - Show receiverGET /v1/receivers/{receiver_token}.{format}
Retrieve details of a specific receiver.
documented - Update receiverPUT /v1/receivers/{receiver_token}.{format}
Update non-credential attributes of a receiver.
documented
Certificates · 5
- Create certificatePOST /v1/certificates.{format}
Create a new certificate.
documented - Generate certificatePOST /v1/certificates/generate.{format}
Generate a certificate based on provided parameters.
documented - List certificatesGET /v1/certificates.{format}
List certificates.
documented - List certificatesGET /v1/certificates.{format}
List certificates.
documented - Update certificatePUT /v1/certificates/{certificate_token}.{format}
Update a certificate record.
documented
Payment Methods · 5
- Create credit cardPOST /v1/payment_methods.{format}
Create (tokenize) a credit card and vault it in Spreedly.
documented - List payment methodsGET /v1/payment_methods.{format}
Retrieve all payment methods retained in the environment.
documented - Redact payment methodPUT /v1/payment_methods/{payment_method_token}/redact.{format}
Redact (strip sensitive data) and deactivate a vaulted payment method.
documented - Show payment methodGET /v1/payment_methods/{payment_method_token}.{format}
Retrieve details of a specific vaulted payment method.
documented - Update payment methodPATCH /v1/payment_methods/{payment_method_token}.{format}
Update non-sensitive attributes of a payment method.
documented
Network Tokens · 4
- Card metadataGET /v1/network_tokenization/card_metadata.{format}?payment_method_token=<token>
Retrieve metadata for a tokenized card.
documented - Card metadataGET /v1/network_tokenization/card_metadata.{format}?payment_method_token=<token>
Retrieve metadata for a tokenized card.
documented - Token statusGET /v1/network_tokenization/token_status.{format}?payment_method_token=<token>
Get the status of a tokenized card.
documented - Token statusGET /v1/network_tokenization/token_status.{format}?payment_method_token=<token>
Get the status of a tokenized card.
documented
SCA Providers · 4
- Create SCA providerPOST /v1/sca/providers.{format}
Create an SCA provider tied to a merchant profile.
documented - Create SCA providerPOST /v1/sca/providers.{format}
Create an SCA provider for a merchant profile.
documented - Show SCA providerGET /v1/sca/providers/{sca_provider_token}.{format}
Show an SCA provider.
documented - Show SCA providerGET /v1/sca/providers/{sca_provider_token}.{format}
Show SCA provider details.
documented