Shopify Payments APIs

The Shopify Payments API lets you access information about a merchant’s Shopify Payments account using the following resources:

• DayOfTheWeek — Days of the week from Monday to Sunday.
• DisputeStatus — The possible statuses of a dispute.
• DisputeType — The possible types for a dispute.
• OrderDisputeSummary — A summary of the important details for a dispute on an order.
• ShopifyPaymentsBankAccount — A bank account that can receive payouts.
• ShopifyPaymentsBankAccountStatus — The bank account status.
• ShopifyPaymentsChargeStatementDescriptor — The charge descriptors for a payments account.
• ShopifyPaymentsDefaultChargeStatementDescriptor — The charge descriptors for a payments account.
• ShopifyPaymentsDispute — A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.
• ShopifyPaymentsDisputeReason — The reason for the dispute provided by the cardholder’s bank.
• ShopifyPaymentsDisputeReasonDetails — Details regarding a dispute reason.
• ShopifyPaymentsFraudSettings — The fraud settings of a payments account.
• ShopifyPaymentsJpChargeStatementDescriptor — The charge descriptors for a Japanese payments account.
• ShopifyPaymentsNotificationSettings — The notification settings for the account.
• ShopifyPaymentsPayout — Payouts represent the movement of money between a merchant’s Shopify Payments balance and their bank account.
• ShopifyPaymentsPayoutInterval — The interval at which payouts are sent to the connected bank account.
• ShopifyPaymentsPayoutSchedule — The payment schedule for a payments account.
• ShopifyPaymentsPayoutStatus — The transfer status of the payout.
• ShopifyPaymentsPayoutSummary — Breakdown of the total fees and gross of each of the different types of transactions associated with the payout.
• ShopifyPaymentsPayoutTransactionType — The possible transaction types for a payout.
• ShopifyPaymentsVerification — Each subject (individual) of an account has a verification object giving information about the verification state.
• ShopifyPaymentsVerificationDocument — A document which can be used to verify an individual.
• ShopifyPaymentsVerificationDocumentType — The types of possible verification documents.
• ShopifyPaymentsVerificationStatus — The status of a verification.
• ShopifyPaymentsVerificationSubject — The verification subject represents an individual that has to be verified.

Versioning of the Shopify Payments API

The REST APIs offer schema versioning through a MIME type in the Accept header of a request. The initial type is application/vnd.shopifypayments.v1+json. By default, all JSON requests receive the most recent version of the API. The client should specify the required version in the Accept header.

A new version will be introduced only for non-backwards compatible changes. For example, adding new properties is considered backwards compatible and will not introduce a new version.

Pagination of Shopify Payments API responses

Requests that return a collection of items is paginated. Every collection response includes a Link header that contains one or more hypermedia link relations for traversing pages. It’s recommended that clients use these provided URLs for traversing collections and do not construct their own, since the parameters are subject to change.

The rel property can have the following values:

• next: The link relation for the immediate next page of results.
• prev: The link relation for the immediate previous page of results.