Skip to content
Developer portal

Overview

Merchant API v1

Section titled “Merchant API v1”

One API for taking payments on every method and channel your account is set up for. Start with the Overview and the Quickstart, then see Authentication, Test mode and test values, Testing your integration and the API basics (Errors, Idempotency, Pagination and Versioning); everything here is /v1.

This reference as an OpenAPI 3.1 document: JSON or YAML.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/v1/payment_intents
POST
/v1/payment_intents
GET
/v1/payment_intents/{id}
POST
/v1/payment_intents/{id}/confirm
POST
/v1/payment_intents/{id}/cancel
GET
/v1/payment_methods
GET
/v1/payment_methods/{id}
POST
/v1/test_helpers/payment_intents/{id}/simulate
GET
/v1/refunds
POST
/v1/refunds
GET
/v1/refunds/{id}
GET
/v1/disputes
GET
/v1/disputes/{id}
GET
/v1/webhook_endpoints
POST
/v1/webhook_endpoints
POST
/v1/webhook_endpoints/{id}
POST
/v1/webhook_endpoints/{id}/disable
POST
/v1/webhook_endpoints/{id}/rotate_secret
POST
/oauth/token
POST
payment_intent.created WEBHOOK
POST
payment_intent.requires_action WEBHOOK
POST
payment_intent.processing WEBHOOK
POST
payment_intent.succeeded WEBHOOK
POST
payment_intent.payment_failed WEBHOOK
POST
payment_intent.canceled WEBHOOK
POST
refund.created WEBHOOK
POST
refund.updated WEBHOOK
POST
refund.succeeded WEBHOOK
POST
refund.failed WEBHOOK
POST
dispute.created WEBHOOK
POST
dispute.updated WEBHOOK
POST
dispute.closed WEBHOOK

Authentication

Section titled “Authentication”

AccessToken

Section titled “AccessToken”

An Access Token from POST /oauth/token, at_test_... or at_live_..., as a Bearer token. It lasts 15 minutes. The client secret is refused here.

Security scheme type: http

ClientSecret

Section titled “ClientSecret”

Your client ID and client secret, ci_test_... and sk_test_... in test mode, sent to the token endpoint only.

Security scheme type: http