Events
リソース | 説明 |
---|---|
GET /api/v1/events | Lists out past webhook events from most-recent to least-recent. |
GET /api/v1/events/:id | View an event given an |
Payments
リソース | 説明 |
---|---|
GET /api/v1/payments | Retrieves a paginated list of payments. Pagination can be configured with Payments can be filtered by A time range can be specified with |
GET /api/v1/payments/:id | Retrieves a single payment object by its |
POST /api/v1/payments | Creates a payment for a given *Must specify exactly one of |
PATCH /api/v1/payments/:id | Updates a payment. Only a payment's |
POST /api/v1/payments/:id/capture | Captures a payment. Only works on payments with a |
POST /api/v1/payments/:id/refund | Refunds an arbitrary amount of money from an existing payment. If no |
POST /api/v1/payments/:id/refund_request | Refund requests can be used for payment methods that do not support refunds e.g. cash-based payment methods like Convenience Store, Bank Transfer, etc. |
POST /api/v1/payments/:id/cancel | Cancels a payment. The given payment must have a |
Sessions
リソース | 説明 |
---|---|
GET /api/v1/sessions/:id | Retrieves a Session given its ID. Useful for checking on a session's status, or to inspect the resulting payment. |
POST /api/v1/sessions | Creates a session. Send your customers to the |
Subscriptions
リソース | 説明 |
---|---|
POST /api/v1/subscriptions | Create a new subscription. A subscription represents a recurring payment. Recurring payments may be on a In order to create a subscription, a customer ID must be supplied. The customer object contains saved payment info, which is regularly charged by the subscription. A subscription can't be modified once it's created. To change a subscription, you must delete it and create a new one. |
GET /api/v1/subscriptions | List existing subscriptions. Paginates with the usual |
GET /api/v1/subscriptions/:id | Show an existing subscription, including its customer and scrubbed payment details. |
DELETE /api/v1/subscriptions/:id | Delete a subscription. Once deleted, the subscription's regular payments will stop. |
Customers
リソース | 説明 |
---|---|
GET /api/v1/customers | Retrieves a paginated list of all previously-registered customers. Does not reveal saved payment details. |
GET /api/v1/customers/:id | Retrieves customer personal information. This endpoint does not reveal the saved payment details. |
POST /api/v1/customers | Creates a new customer with the specified Once you have a customer, you may specify the customer's |
PATCH /api/v1/customers/:id | Updates the customer with the given |
DELETE /api/v1/customers/:id | Deletes the customer with the given |
Tokens
リソース | 説明 |
---|---|
POST /api/v1/tokens | Creates a token with the given It is recommended to have a client application make this request directly so that sensitive payment information (e.g. credit card number) doesn't hit your server. Receiving credit card numbers requires your business to be PCI-DSS compliant. Once you turn your customer's details into a token, the token string can safely be sent to your server and used as A Tokens can't be indexed or deleted via API. Tokens are instead deleted on use, and expire when unused. |
Secure Tokens
リソース | 説明 |
---|---|
GET /api/v1/secure_tokens/:id | Retrieves a Session given its ID. Useful for checking on a session's status, or to inspect the resulting payment. Note, we are currently expanding 3D Secure 2.0 support for merchants. This API might not be available on your merchants. |
POST /api/v1/secure_tokens | Create a new Secure Token. Navigate your customers to |