Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ravelin Transactions API

Payment attempts, captures, refunds, and authorizations.

Ravelin Transactions API is one of 13 APIs that Ravelin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against a single base URL, https://3ds.live.pci.ravelin.com.

2 operations 2 paths 6 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Base URL
https://api.ravelin.com
Authentication
API Key
License
Proprietary
Terms of Service
Resource Areas
1

Authentication & Security 1

Ravelin Transactions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (secretApiKey). By default, every request must be authenticated.

  • secretApiKey — Secret API key prefixed with token.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Transactions 2

Payment attempts, captures, refunds, and authorizations.

POST
/v2/transaction
Submit a Transaction Event
createTransaction body → 200401429
POST
/v2/payment-method
Submit a Payment Method
createPaymentMethod body → 200401429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TransactionRequest (7 properties), Device (5 properties), DecisionResponse (4 properties), PaymentMethod (4 properties). Each schema is shown below with its type and property counts.

TransactionRequest
object
7 properties 3 required
PaymentMethodRequest
object
3 properties 3 required
Error
object
3 properties
Device
object
5 properties
PaymentMethod
object
4 properties
DecisionResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ravelin-transactions-api-openapi.yml Raw ↑

Other APIs Ravelin publishes across the network.

Ravelin PSP API
Ravelin Callbacks API
Ravelin 3D Secure API
Ravelin Authentication API
Ravelin Checkout API
Ravelin Connect API
Ravelin Customer API
Ravelin Disputes API
Ravelin Payouts API
Ravelin Refunds API
Ravelin Supplier API
Ravelin Vouchers API