How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Spreedly Payment Methods API

The payment_methods API from Spreedly — 12 operation(s) for payment_methods.

Spreedly Payment Methods API is one of 26 APIs that Spreedly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Methods. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 14 operations across 12 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://core.spreedly.com/v1.

14 operations 12 paths 34 schemas 1 DELETE6 GET3 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://core.spreedly.com/v1
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Spreedly Payment Methods API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth).

  • basic_auth — Unless otherwise noted, all calls to the Spreedly API use [HTTP basic authentication](https://en.wikipedia.org/wiki/Basicaccessauthentication) over HTTPS. Use…

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 1 DELETE, 6 GET, 3 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

payment_methods 14
GET
/payment_methods/events
List all payment method events
list-all-payment-method-events 5 params → 200401
GET
/payment_methods/events/{event_token}
Show payment method event
show-payment-method-event 1 param → 200401404
POST
/payment_methods
Create payment method
create-payment-method body → 201422
GET
/payment_methods
List payment methods
list-payment-method 5 params → 200401
GET
/payment_methods/{payment_method_token}
Show payment method
show-payment-method 1 param → 200401404
PUT
/payment_methods/{payment_method_token}
Update payment method
update-payment-method 1 param body → 200401404422
PUT
/payment_methods/{payment_method_token}/retain
Retain payment method
retain-payment-method 1 param body → 200401404422
PUT
/payment_methods/{payment_method_token}/redact
Redact payment method
redact-payment-method 1 param body → 200401404
PUT
/payment_methods/{payment_method_token}/update_gratis
Update gratis payment method
update-gratis-payment-method 1 param body → 200401404422
GET
/payment_methods/{payment_method_token}/transactions
List transactions payment method
list-transactions-payment-method 3 params → 200401
DELETE
/payment_methods/{payment_method_token}/metadata
Delete metadata payment method
delete-metadata-payment-method 1 param body → 200401404
POST
/payment_methods/{payment_method_token}/recache
Recache payment method
recache-payment-method 1 param body → 200404422
GET
/payment_methods/{payment_method_token}/events
List events for a payment method
list-events-payment-method 5 params → 200401404
POST
/gateways/{gateway_token}/store
Create a store transaction
payment_method.store 1 param body → 200401422

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are payment_method (42 properties), protection_parameters (32 properties), protect_fraud_check_response (23 properties), credit_card (22 properties). Each schema is shown below with its type and property counts.

store_response
object
1 property
payment_method_update
object
1 property
payment_method_response
object
1 property
payment_snapshot
object
When Recover is attempted, provides an overview of the results at the time of the current transaction. For more information on Recover, see [the guide](https:/…
10 properties
store
object
1 property
payment_method_update_gratis
object
1 property
transaction_core_parameters
object
16 properties
bank_account
object
7 properties 4 required
payment_method_request
object
1 property
payment_method_retain_response
object
1 property
payment_method_events_response
object
1 property
transactions_response
object
1 property
payment_method_redact
object
1 property
protection_parameters
object
Additional fields that are accepted by the Protection provider, including a testscenario object to indicate valid Protect test flow options. Please refer to ou…
32 properties 3 required
network_token
object
Network token details for a payment method
7 properties
payment_method_event_response
object
1 property
provision_network_token
boolean
true if this transaction should attempt to provision a network token. false or omit this element to not provision a network token for this transaction. Please…
protect_fraud_check_response
object
When a Fraud Check is attempted, provides an overview of the results at the time of the current transaction. For more information on Protection Fraud Checks, s…
23 properties
apple_pay
object
2 properties 1 required
payment_method
object
42 properties
payment_method_redact_response
object
1 property
google_pay
object
10 properties 1 required
recache
object
1 property
delete_metadata
object
1 property
payment_method_create_response
object
1 property
third_party_token
object
8 properties
payment_methods_response
object
1 property
credit_card
object
Credit card element
22 properties 5 required
network_tokenization
object
The network tokenization details for the transaction
9 properties
payment_method_show_response
object
1 property
payment_method_event
object
8 properties
gateway_specific_fields
array
The list of gateway specific fields that can be specified in supported gateway transactions
errors
array
purchase_parameters
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spreedly-payment-methods-api-openapi.yml Raw ↑

Other APIs Spreedly publishes across the network.

Spreedly Access Secrets API
Spreedly Authorize API
Spreedly Capture API
Spreedly Card Refresher API
Spreedly Certificates API
Spreedly Claim API
Spreedly Composer API
Spreedly Credit API
Spreedly Environments API
Spreedly Events API
Spreedly Gateways API
Spreedly General Credit API
Where this information came from

This is an independent, third-party profile of Spreedly Payment Methods API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.