The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Apple Pay Certificate
mobile_payments
access scope.You can use the ApplePayCertificate
resource to create a certificate signing request (CSR) and upload the signed certificate from Apple to Shopify.
To use the resource, you'll first need to send a POST request to the ApplePayCertificate
resource to obtain an id
.
You'll then use this id
to create a base64 encoded key to be included in the body of your CSR to Apple.
After you've uploaded the CSR to Apple and received the certificate, you'll provide it to Shopify by using a PUT request.
Endpoints
- post/admin/api/2025-01/apple_
pay_ certificates. json Create an Apple Pay certificate - get/admin/api/2025-01/apple_
pay_ certificates/{apple_ pay_ certificate_ id}. json Retrieve an Apple Pay certificate - get/admin/api/2025-01/apple_
pay_ certificates/{apple_ pay_ certificate_ id}/csr. json Create a base64 encoded key to be included in the body of the CSR - put/admin/api/2025-01/apple_
pay_ certificates/{apple_ pay_ certificate_ id}. json Upload Apple Pay certificate to enable Apple Pay on your app - del/admin/api/2025-01/apple_
pay_ certificates/{apple_ pay_ certificate_ id}. json Delete Apple Pay certificate
The ApplePayCertificate resource
Properties
Unique numeric identifier for the Apple Pay certificate.
Status of your Apple Pay certificate. Possible values are issuing
,
csr
, or completed
.
Merchant ID for your Apple Pay certificate.
The ApplePayCertificate resource
Anchor to POST request, Create an Apple Pay certificatepostCreate an Apple Pay certificate
Create an Apple Pay certificate
Create an Apple Pay certificate
Create an Apple Pay certificate
/admin/api/2025-01/apple_ pay_ certificates. json
Response
examples
Create an Apple Pay certificate
curl -d '{"apple_pay_certificate":{}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"
const { admin, session } = await authenticate.admin(request); const apple_pay_certificate = new admin.rest.resources.ApplePayCertificate({session: session}); await apple_pay_certificate.save({ update: true, });
# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session apple_pay_certificate = ShopifyAPI::ApplePayCertificate.new(session: test_session) apple_pay_certificate.save!
// Session is built by the OAuth process const apple_pay_certificate = new shopify.rest.ApplePayCertificate({session: session}); await apple_pay_certificate.save({ update: true, });
response
HTTP/1.1 201 Created{"apple_pay_certificate":{"id":1068938278,"status":"issuing","merchant_id":null}}
Anchor to GET request, Retrieve an Apple Pay certificategetRetrieve an Apple Pay certificate
Retrieve an Apple Pay certificate
Retrieve an Apple Pay certificate
Retrieve an Apple Pay certificate
/admin/api/2025-01/apple_ pay_ certificates/1068938274. json
Response
examples
Retrieve an Apple Pay certificate
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates/1068938274.json" \ -H "X-Shopify-Access-Token: {access_token}"
await admin.rest.resources.ApplePayCertificate.find({ session: session, id: 1068938274, });
# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::ApplePayCertificate.find( session: test_session, id: 1068938274, )
// Session is built by the OAuth process await shopify.rest.ApplePayCertificate.find({ session: session, id: 1068938274, });
response
HTTP/1.1 200 OK{"apple_pay_certificate":{"id":1068938274,"status":"csr","merchant_id":null}}
Anchor to GET request, Create a base64 encoded key to be included in the body of the CSRgetCreate a base64 encoded key to be included in the body of the CSR
Create a base64 encoded key to be included in the body of the CSR
Create a base64 encoded key to be included in the body of the CSR
Create a base64 encoded key to be included in the body of the CSR
/admin/api/2025-01/apple_ pay_ certificates/1068938275/csr. json
Response
examples
Create a base64 encoded key to be included in the body of the CSR
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates/1068938275/csr.json" \ -H "X-Shopify-Access-Token: {access_token}"
await admin.rest.resources.ApplePayCertificate.csr({ session: session, id: 1068938275, });
# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::ApplePayCertificate.csr( session: test_session, id: 1068938275, )
// Session is built by the OAuth process await shopify.rest.ApplePayCertificate.csr({ session: session, id: 1068938275, });
response
HTTP/1.1 200 OK{"csr":{"key":"YXBwbGUtcGF5LWNzcg==\n"}}
Anchor to PUT request, Upload Apple Pay certificate to enable Apple Pay on your appputUpload Apple Pay certificate to enable Apple Pay on your app
Upload Apple Pay certificate to enable Apple Pay on your app
Upload Apple Pay certificate to enable Apple Pay on your app
Upload Apple Pay certificate to enable Apple Pay on your app
Show apple_pay_certificate properties
Unique numeric identifier for the Apple Pay certificate.
Status of your Apple Pay certificate. Possible values are issuing
,
csr
, or completed
.
Merchant ID for your Apple Pay certificate.
/admin/api/2025-01/apple_ pay_ certificates/1068938276. json
Response
examples
Upload Apple Pay certificate to enable Apple Pay on your app
curl -d '{"apple_pay_certificate":{"id":1068938276,"status":"completed","merchant_id":"merchant.something","encoded_signed_certificate":"MIIEZzCCBA6gAwIBAgIIWGMideLkDJAwCgYIKoZIzj0EAwIwgYAxNDAyBgNV\nBAMMK0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0g\nRzIxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMw\nEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xNDEyMDgyMTMy\nMDBaFw0xNzAxMDYyMTMyMDBaMIGZMSowKAYKCZImiZPyLGQBAQwabWVyY2hh\nbnQuY29tLm5vcm1vcmUuamFzb24xMDAuBgNVBAMMJ01lcmNoYW50IElEOiBt\nZXJjaGFudC5jb20ubm9ybW9yZS5qYXNvbjETMBEGA1UECwwKNVVZMzJOTE5O\nOTEXMBUGA1UECgwOSm9zaHVhIFRlc3NpZXIxCzAJBgNVBAYTAkNBMFkwEwYH\nKoZIzj0CAQYIKoZIzj0DAQcDQgAEAxDDCvzG6MnsZSJOtbr0hr3MRq+4HzTZ\nx8J4FD34E3kU5CallEnZLBmnzfqmjP8644SO28LLJxvWBnrg7lHFtaOCAlUw\nggJRMEcGCCsGAQUFBwEBBDswOTA3BggrBgEFBQcwAYYraHR0cDovL29jc3Au\nYXBwbGUuY29tL29jc3AwNC1hcHBsZXd3ZHJjYTIwMTAdBgNVHQ4EFgQUkPsO\nKEKvhL/takKomy5GWXtCd8wwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBSE\ntoTMOoZichZZlOgao71I3zrfCzCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZI\nhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMg\nY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBv\nZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25k\naXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZp\nY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRw\nOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNgYDVR0f\nBC8wLTAroCmgJ4YlaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGV3d2RyY2Ey\nLmNybDAOBgNVHQ8BAf8EBAMCAygwTwYJKoZIhvdjZAYgBEIMQDM0NTBBMjhB\nOTlGRjIyRkI5OTdDRERFODU1REREOTI5NTE4RjVGMDdBQUM4NzdDMzRCQjM3\nODFCQTg2MzkyNjIwCgYIKoZIzj0EAwIDRwAwRAIgZ/oNx0gCc/PM4pYhOWL2\nCecFQrIgzHr/fZd8qcy3Be8CIEQCaAPpmvQrXEX0hFexoYMHtOHY9dgN2D8L\nNKpVyn3t\n"}}' \ -X PUT "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates/1068938276.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"
const { admin, session } = await authenticate.admin(request); const apple_pay_certificate = new admin.rest.resources.ApplePayCertificate({session: session}); apple_pay_certificate.id = 1068938276; apple_pay_certificate.status = "completed"; apple_pay_certificate.merchant_id = "merchant.something"; apple_pay_certificate.encoded_signed_certificate = "MIIEZzCCBA6gAwIBAgIIWGMideLkDJAwCgYIKoZIzj0EAwIwgYAxNDAyBgNV\nBAMMK0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0g\nRzIxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMw\nEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xNDEyMDgyMTMy\nMDBaFw0xNzAxMDYyMTMyMDBaMIGZMSowKAYKCZImiZPyLGQBAQwabWVyY2hh\nbnQuY29tLm5vcm1vcmUuamFzb24xMDAuBgNVBAMMJ01lcmNoYW50IElEOiBt\nZXJjaGFudC5jb20ubm9ybW9yZS5qYXNvbjETMBEGA1UECwwKNVVZMzJOTE5O\nOTEXMBUGA1UECgwOSm9zaHVhIFRlc3NpZXIxCzAJBgNVBAYTAkNBMFkwEwYH\nKoZIzj0CAQYIKoZIzj0DAQcDQgAEAxDDCvzG6MnsZSJOtbr0hr3MRq+4HzTZ\nx8J4FD34E3kU5CallEnZLBmnzfqmjP8644SO28LLJxvWBnrg7lHFtaOCAlUw\nggJRMEcGCCsGAQUFBwEBBDswOTA3BggrBgEFBQcwAYYraHR0cDovL29jc3Au\nYXBwbGUuY29tL29jc3AwNC1hcHBsZXd3ZHJjYTIwMTAdBgNVHQ4EFgQUkPsO\nKEKvhL/takKomy5GWXtCd8wwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBSE\ntoTMOoZichZZlOgao71I3zrfCzCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZI\nhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMg\nY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBv\nZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25k\naXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZp\nY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRw\nOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNgYDVR0f\nBC8wLTAroCmgJ4YlaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGV3d2RyY2Ey\nLmNybDAOBgNVHQ8BAf8EBAMCAygwTwYJKoZIhvdjZAYgBEIMQDM0NTBBMjhB\nOTlGRjIyRkI5OTdDRERFODU1REREOTI5NTE4RjVGMDdBQUM4NzdDMzRCQjM3\nODFCQTg2MzkyNjIwCgYIKoZIzj0EAwIDRwAwRAIgZ/oNx0gCc/PM4pYhOWL2\nCecFQrIgzHr/fZd8qcy3Be8CIEQCaAPpmvQrXEX0hFexoYMHtOHY9dgN2D8L\nNKpVyn3t\n"; await apple_pay_certificate.save({ update: true, });
# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session apple_pay_certificate = ShopifyAPI::ApplePayCertificate.new(session: test_session) apple_pay_certificate.id = 1068938276 apple_pay_certificate.status = "completed" apple_pay_certificate.merchant_id = "merchant.something" apple_pay_certificate.encoded_signed_certificate = "MIIEZzCCBA6gAwIBAgIIWGMideLkDJAwCgYIKoZIzj0EAwIwgYAxNDAyBgNV\nBAMMK0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0g\nRzIxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMw\nEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xNDEyMDgyMTMy\nMDBaFw0xNzAxMDYyMTMyMDBaMIGZMSowKAYKCZImiZPyLGQBAQwabWVyY2hh\nbnQuY29tLm5vcm1vcmUuamFzb24xMDAuBgNVBAMMJ01lcmNoYW50IElEOiBt\nZXJjaGFudC5jb20ubm9ybW9yZS5qYXNvbjETMBEGA1UECwwKNVVZMzJOTE5O\nOTEXMBUGA1UECgwOSm9zaHVhIFRlc3NpZXIxCzAJBgNVBAYTAkNBMFkwEwYH\nKoZIzj0CAQYIKoZIzj0DAQcDQgAEAxDDCvzG6MnsZSJOtbr0hr3MRq+4HzTZ\nx8J4FD34E3kU5CallEnZLBmnzfqmjP8644SO28LLJxvWBnrg7lHFtaOCAlUw\nggJRMEcGCCsGAQUFBwEBBDswOTA3BggrBgEFBQcwAYYraHR0cDovL29jc3Au\nYXBwbGUuY29tL29jc3AwNC1hcHBsZXd3ZHJjYTIwMTAdBgNVHQ4EFgQUkPsO\nKEKvhL/takKomy5GWXtCd8wwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBSE\ntoTMOoZichZZlOgao71I3zrfCzCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZI\nhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMg\nY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBv\nZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25k\naXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZp\nY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRw\nOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNgYDVR0f\nBC8wLTAroCmgJ4YlaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGV3d2RyY2Ey\nLmNybDAOBgNVHQ8BAf8EBAMCAygwTwYJKoZIhvdjZAYgBEIMQDM0NTBBMjhB\nOTlGRjIyRkI5OTdDRERFODU1REREOTI5NTE4RjVGMDdBQUM4NzdDMzRCQjM3\nODFCQTg2MzkyNjIwCgYIKoZIzj0EAwIDRwAwRAIgZ/oNx0gCc/PM4pYhOWL2\nCecFQrIgzHr/fZd8qcy3Be8CIEQCaAPpmvQrXEX0hFexoYMHtOHY9dgN2D8L\nNKpVyn3t\n" apple_pay_certificate.save!
// Session is built by the OAuth process const apple_pay_certificate = new shopify.rest.ApplePayCertificate({session: session}); apple_pay_certificate.id = 1068938276; apple_pay_certificate.status = "completed"; apple_pay_certificate.merchant_id = "merchant.something"; apple_pay_certificate.encoded_signed_certificate = "MIIEZzCCBA6gAwIBAgIIWGMideLkDJAwCgYIKoZIzj0EAwIwgYAxNDAyBgNV\nBAMMK0FwcGxlIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENBIC0g\nRzIxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMw\nEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0xNDEyMDgyMTMy\nMDBaFw0xNzAxMDYyMTMyMDBaMIGZMSowKAYKCZImiZPyLGQBAQwabWVyY2hh\nbnQuY29tLm5vcm1vcmUuamFzb24xMDAuBgNVBAMMJ01lcmNoYW50IElEOiBt\nZXJjaGFudC5jb20ubm9ybW9yZS5qYXNvbjETMBEGA1UECwwKNVVZMzJOTE5O\nOTEXMBUGA1UECgwOSm9zaHVhIFRlc3NpZXIxCzAJBgNVBAYTAkNBMFkwEwYH\nKoZIzj0CAQYIKoZIzj0DAQcDQgAEAxDDCvzG6MnsZSJOtbr0hr3MRq+4HzTZ\nx8J4FD34E3kU5CallEnZLBmnzfqmjP8644SO28LLJxvWBnrg7lHFtaOCAlUw\nggJRMEcGCCsGAQUFBwEBBDswOTA3BggrBgEFBQcwAYYraHR0cDovL29jc3Au\nYXBwbGUuY29tL29jc3AwNC1hcHBsZXd3ZHJjYTIwMTAdBgNVHQ4EFgQUkPsO\nKEKvhL/takKomy5GWXtCd8wwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBSE\ntoTMOoZichZZlOgao71I3zrfCzCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZI\nhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMg\nY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBv\nZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25k\naXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZp\nY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRw\nOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNgYDVR0f\nBC8wLTAroCmgJ4YlaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGV3d2RyY2Ey\nLmNybDAOBgNVHQ8BAf8EBAMCAygwTwYJKoZIhvdjZAYgBEIMQDM0NTBBMjhB\nOTlGRjIyRkI5OTdDRERFODU1REREOTI5NTE4RjVGMDdBQUM4NzdDMzRCQjM3\nODFCQTg2MzkyNjIwCgYIKoZIzj0EAwIDRwAwRAIgZ/oNx0gCc/PM4pYhOWL2\nCecFQrIgzHr/fZd8qcy3Be8CIEQCaAPpmvQrXEX0hFexoYMHtOHY9dgN2D8L\nNKpVyn3t\n"; await apple_pay_certificate.save({ update: true, });
response
HTTP/1.1 200 OK{"apple_pay_certificate":{"id":1068938276,"status":"completed","merchant_id":"merchant.something"}}
Anchor to DELETE request, Delete Apple Pay certificatedelDelete Apple Pay certificate
Delete Apple Pay certificate
Delete Apple Pay certificate
Delete Apple Pay certificate
/admin/api/2025-01/apple_ pay_ certificates/1068938277. json
Response
examples
Delete Apple Pay certificate
curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-01/apple_pay_certificates/1068938277.json" \ -H "X-Shopify-Access-Token: {access_token}"
await admin.rest.resources.ApplePayCertificate.delete({ session: session, id: 1068938277, });
# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::ApplePayCertificate.delete( session: test_session, id: 1068938277, )
// Session is built by the OAuth process await shopify.rest.ApplePayCertificate.delete({ session: session, id: 1068938277, });
response
HTTP/1.1 204 No Content