POST
/
apple-pay-certificates
curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/apple-pay-certificates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "display_name": "iPad App v2"
}'
{
  "type": "apple-pay-certificate",
  "id": "c81bdcfd-00c2-4897-b220-06ff0e95685a",
  "display_name": "iPad App v2",
  "status": "incomplete",
  "apple_merchant_id": null,
  "public_key_hash": null,
  "certificate_signing_request": "-----BEGIN CERTIFICATE REQUEST-----\\nMIHTMHsCAQAwGTEXMBUG\nA1UEAwwOc3BpZGVyLnNhbmRib3gwWTATBgcqhkjOPQIB\\nBggqhkjOPQM\nBBwNCAAQZgRE56Evtf6f9fD4Hn1zOMwyrgXU4CQXuyPXoIjiMwKXE\\nV/\nHx9NX7vZbOSXhyzPaU/b6HdLMfx2+UP/GZ48jYoAAwCgYIKoZIzj0EAwI\nDSAAw\\nRQIgPhcfepIaX9s8E8WI/T+GEUqwuYIoVUQV+F8KlaYGukACIQ\nCLeLocEFWFYPHN\\n+QsLoyXvbbqmEjSPB4vQKmXQZ8I2DA==\\n-----EN\nD CERTIFICATE REQUEST-----\\n",
  "expires_at": null,
  "created_at": "2022-12-12T10:53:43+00:00",
  "updated_at": "2022-12-12T10:53:43+00:00"
}

This endpoint requires the apple-pay-certificates.write scope.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A request to start the registration of a new Apple Pay payment processing certificate.

​
display_name
string
required

A name for this Apple Pay certificate which is used in the Gr4vy admin panel to give the Apple Pay certificate a human readable name.

Required string length: 1 - 200
Example:

"iPad App v2"

Response

201
application/json
Returns the Apple Pay certificate record that was added.

An Apple Pay certificate record.

​
type
enum<string>

The type of this resource. Is always apple-pay-certificate.

Available options:
apple-pay-certificate
Example:

"apple-pay-certificate"

​
id
string

The unique identifier for this Apple Pay certificate record.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

​
display_name
string

The name for this Apple Pay certificate which is used in the Gr4vy admin panel to give the Apple Pay certificate a human readable name.

Example:

"iPad App v2"

​
status
enum<string>

The status of this Apple Pay certificate.

Available options:
active,
expired,
incomplete
Example:

"active"

​
apple_merchant_id
string | null

The unique identifier representing a merchant for Apple Pay. This value is populated after the Apple Pay certificate record has been updated with the payment processing certificate received from Apple.

Example:

"merchant.com.gr4vy.demo"

​
public_key_hash
string | null

The hash value of the public key associated with this Apple Pay certificate. This value is populated after the Apple Pay certificate record has been updated with the payment processing certificate received from Apple.

Example:

"WSOIlV70592m1ah1sm0mcmhJPQsAIWGSg7FSe+uzHtc="

​
certificate_signing_request
string | null

The Certificate Signing Request to upload to the Apple Developer console when creating a new payment processing certificate.

Example:

"-----BEGIN CERTIFICATE REQUEST-----\\nMIHTMHsCAQAwGTEXMBUG\nA1UEAwwOc3BpZGVyLnNhbmRib3gwWTATBgcqhkjOPQIB\\nBggqhkjOPQM\nBBwNCAAQZgRE56Evtf6f9fD4Hn1zOMwyrgXU4CQXuyPXoIjiMwKXE\\nV/\nHx9NX7vZbOSXhyzPaU/b6HdLMfx2+UP/GZ48jYoAAwCgYIKoZIzj0EAwI\nDSAAw\\nRQIgPhcfepIaX9s8E8WI/T+GEUqwuYIoVUQV+F8KlaYGukACIQ\nCLeLocEFWFYPHN\\n+QsLoyXvbbqmEjSPB4vQKmXQZ8I2DA==\\n-----EN\nD CERTIFICATE REQUEST-----\\n"

​
expires_at
string | null

The date and time this Apple Pay certificate expires. This value is populated after the Apple Pay certificate record has been updated with the payment processing certificate received from Apple.

Example:

"2013-07-16T19:23:00.000+00:00"

​
created_at
string

The date and time this Apple Pay certificate record was created in our system.

Example:

"2013-07-16T19:23:00.000+00:00"

​
updated_at
string

The date and time this Apple Pay certificate record was last updated.

Example:

"2013-07-16T19:23:00.000+00:00"

Was this page helpful?

List certificatesUpdate certificate