api
Cancel

No result found for:

Apple Pay

The Apple Pay API allows you register your application's top-level domain or subdomain.

Feature Availability

This feature is available to businesses in all markets except South Africa.

Register Domain

Register a top-level domain or subdomain for your Apple Pay integration.

Domain Registration

This endpoint can only be called with one domain or subdomain at a time.

Headers
authorization
String
Set value to Bearer SECRET_KEY
content-type
String
Set value to application/json
Body Parameters
domainName
String
Domain name to be registered
POST/apple-pay/domain
cURL
1#!/bin/sh
2url="https://api.paystack.co/apple-pay/domain"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4content_type="Content-Type: application/json"
5data='{ 
6  "domainName": "example.com" 
7}'
8

9curl "$url" -H "$authorization" -H "$content_type" -d "$data" -X POST
Sample Response
200 Ok
1{
2  "status": true,
3  "message": "Domain successfully registered on Apple Pay"
4}

List Domains

Lists all registered domains on your integration. Returns an empty array if no domains have been added.

Headers
authorization
String
Set value to Bearer SECRET_KEY
Query Parameters
use_cursor
boolean
Flag to enable cursor pagination on the endpoint
next
String
A cursor that indicates your place in the list. It can be used to fetch the next page of the list
previous
String
A cursor that indicates your place in the list. It should be used to fetch the previous page of the list after an intial next request
Show optional parameters
GET/apple-pay/domain
cURL
1#!/bin/sh
2url="https://api.paystack.co/apple-pay/domain"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4

5curl "$url" -H "$authorization" -X GET
Sample Response
200 Ok
1{
2  "status": true,
3  "message": "Apple Pay registered domains retrieved",
4  "data": {
5    "domainNames": [
6      "example.com"
7    ]
8  }
9}

Unregister Domain

Unregister a top-level domain or subdomain previously used for your Apple Pay integration.

Headers
authorization
String
Set value to Bearer SECRET_KEY
Body Parameters
domainName
String
Domain name to be registered
DEL/apple-pay/domain
cURL
1#!/bin/sh
2url="https://api.paystack.co/apple-pay/domain"
3authorization="Authorization: Bearer YOUR_SECRET_KEY"
4content_type="Content-Type: application/json"
5data='{ 
6  "domainName": "example.com"
7}'
8

9curl "$url" -H "$authorization" -H "$content_type" -d "$data" -X DELETE
Sample Response
200 Ok
1{
2  "status": true,
3  "message": "Domain successfully unregistered on Apple Pay"
4}