Skip to content
ShuttleShuttle Docs
Status

Merchant instance API

Merchant instance API 1.0.0

Section titled “Merchant instance API 1.0.0”

The Merchant Instance API is the core of the Shuttle platform. It provides direct access to all payment resources within a single merchant instance.

Read the full Merchant instance API introduction.

Operations

Section titled “Operations”
GET
/accounts
POST
/accounts
GET
/accounts/{account_id}
PUT
/accounts/{account_id}
GET
/captures/{capture_id}
GET
/charges
GET
/charges/{charge_id}
PUT
/charges/{charge_id}
POST
/checkout_monitor
POST
/checkouts
GET
/checkouts/{nonce}
DELETE
/checkouts/{nonce}
GET
/contracts
GET
/contracts/{contract_id}
PUT
/contracts/{contract_id}
GET
/contracts/{contract_id}/future_charges
GET
/contracts/{contract_id}/charges
POST
/contracts/{contract_id}/cancel
POST
/contracts/{contract_id}/payment
POST
/contracts/{contract_id}/payment_method_url
POST
/deep_links
GET
/deep_links/{deep_link_id}
PUT
/deep_links/{deep_link_id}
DELETE
/deep_links/{deep_link_id}
GET
/gateways
POST
/gateways
GET
/gateways/{gateway_id}
PUT
/gateways/{gateway_id}
GET
/gateways/{gateway_id}/connection
GET
/gateways/{gateway_id}/settings
GET
/gateways/{gateway_id}/payment_method_count
GET
/capabilities
GET
/legal_entities
GET
/legal_entities/{legal_entity_id}
GET
/legal_entity_routes
GET
/legal_entity_routes/{legal_entity_route_id}
GET
/payment_links/{id}
PUT
/payment_links/{id}
DELETE
/payment_links/{id}
POST
/payment_links
GET
/payment_methods
POST
/payment_methods
GET
/payment_methods/{payment_method_id}
PUT
/payment_methods/{payment_method_id}
DELETE
/payment_methods/{payment_method_id}
POST
/payments
GET
/payments/{payment_id}
POST
/payments/{payment_id}/refund
POST
/payments/{payment_id}/capture
POST
/payments/{payment_id}/void
GET
/processors
GET
/processors/{processor_id}/settings
GET
/refunds/{refund_id}
POST
/captures/{capture_id}/refund
POST
/contracts/{contract_id}/refund
GET
/strings
POST
/strings
GET
/strings/{string_id}
PUT
/strings/{string_id}
DELETE
/strings/{string_id}
GET
/transactions
GET
/transactions/{transaction_id}
GET
/voids/{void_id}
GET
/workflows
GET
/workflows/{workflow_id}
GET
/workflows/{workflow_id}/connection
GET
/workflows/{workflow_id}/settings

Authentication

Section titled “Authentication”

basicAuth

Section titled “basicAuth”

Basic Authentication using secret key

Security scheme type: http

bearerAuth

Section titled “bearerAuth”

OAuth 2.0 Bearer Token Authentication

Security scheme type: http

Was this page helpful?