POST
/
apple-pay-certificates

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

Authorizations

Authorization
string
headerrequired

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

Response

201 - application/json

An Apple Pay certificate record.

type
enum<string>

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

Available options:
apple-pay-certificate
id
string

The unique identifier for this Apple Pay certificate record.

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.

status
enum<string>

The status of this Apple Pay certificate.

Available options:
active,
expired,
incomplete
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.

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.

certificate_signing_request
string | null

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

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.

created_at
string

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

updated_at
string

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