Apple Pay

Overview

Introduction

Apple Pay is a payment method which allows to process payments in different currencies by using Apple Pay services in different regions. This method supports one-time and credential-on-file purchases, refunds and payment card verification, as well as payouts.

This article provides information about working with the Apple Pay method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type digital wallet payments
Payment instruments payments cards
Countries and regions the list is available at the link
Payment currencies all currencies supported by American Express, Maestro, Mastercard and Visa payment systems in supported regions
Currency conversion on the ecommpay side
One-time purchases +
Credential-on-file purchases +
Full refunds +
Partial refunds +
Payouts +
Card verification +
Chargebacks +
Notes
  • devices—from the list of supported Apple devices
  • browser—Safari
  • payment cards—American Express, Maestro, Mastercard, Visa
  • the way of Payment Page opening — any way except opening a Payment Page embedded into a web page
  • requirements to the merchant web service for purchases via Gate support:
    • the site domain should be registered in the Apple services. For registration follow step-by-step instructions provided on Apple developer portal
    • the site supports scripting functionality to start an Apple session according to documentation
  • payouts can only be made to payment cards registered in the Apple Pay service only after at least one purchase has been processed by using such card
Onboarding and access fee refer to your ecommpay key account manager, additional information available in the ecommpay shop

Interaction diagram

Payment processing by using the Apple Pay method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the Apple Pay service.



Operations support

Various platform interfaces can be used to process payments and perform operations using the Apple Pay method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links), refunds and payouts—by using Gate and Dashboard.

Processing scenarios

To perform a purchase by using the Apple Pay method, the payment session must be initiated and the customer needs to perform the required steps, while to make a refund you need to receive a request from the customer and notify the customer about the result of the refund via the web service. To process a payout, you need to notify the customer via the web service.

Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.

Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the Apple Pay method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure: Purchase processing by using Payment Page: step-by-step description

  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Apple Pay method.
  8. The payment platform receives the request for processing the payment by using the Apple Pay method.
  9. The payment platform processes the request and sends it to the Apple Pay service.
  10. The request for starting payment session is processed and the session data is generated on the Apple Pay service side.
  11. The payment platform receives the payment session information from the Apple Pay service.
  12. Payment Page receives the payment session initialisation data from the payment platform.
  13. Payment Page initiates the payment session and displays the Apple Pay app or interface for purchase confirmation to the customer.
  14. The customer completes all required steps and confirms the purchase.
  15. The customer data is processed on the Apple Pay service side.
  16. The customer is redirected to the Payment Page loading page.
  17. The payment platform receives encrypted customer data from the Apple Pay service.
  18. The payment platform processes the request and sends it to the card organisation service.
  19. The purchase is processed in the card organisation service.
  20. The card organisation service sends a notification about the result to the payment platform.
  21. The payment platform sends the payment result callback to the web service.
  22. The payment platform sends the result information to Payment Page.
  23. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the Apple Pay method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Apple Pay method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. If you need to have payment form displayed with the Apple Pay method selected, set the force_payment_method parameter to:
    • apple_pay_core—to open Payment Page with pre-selected payment method Apple Pay
    • card—for the ability of payment by using either a payment card or Apple Pay. In this case customer can chose the payment method on Payment Page
  4. Additionally, any other parameters available for working with Payment Page can be used (details).
  5. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Apple Pay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Figure: Example of sufficient data in a purchase request

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The Apple Pay method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The callbacks containing information about processed purchases include the token of the card in the token parameter of the account object, which can only be used for initiating payouts.

The following is the example of a callback with information about a 1,000.00 USD purchase in the 580 project.

Figure: Example of callback data indicating that the purchase has been processed

{
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_15671726468667687",
            "type": "purchase",
            "status": "success",
            "date": "2019-08-30T13:58:12+0000",
            "method": "etoken",
            "sum": {
                "amount": 100000,
                "currency": "USD"
            },
            "description": "ECT_TEST_1567172646866"
        },
        "account": {
            "number": "431422******0056"
        },
        "operation": {
            "id": 47478000001698,
            "type": "sale",
            "status": "success",
            "date": "2019-08-30T13:58:12+0000",
            "created_date": "2019-08-30T13:58:06+0000",
            "request_id": "0a5cb476be3a55010fb050ec1c1cbd35361ac912a3",
            "sum_initial": {
                "amount": 100000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "USD"
            },
            "provider": {
                "id": 1187,
                "payment_id": "24fb3f30-000f-5000-8000-1c329d900c68",
                "date": "2019-08-30T13:58:09+0000",
                "auth_code": "591748"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "5DtWEGy+dMGZZnm3Owjgw9ly67Mb9siv7+WD1u7AyIYdQ=="
    }
}

The following is the example of a callback for a purchase declined due to insufficient funds on card.

Figure: Example of callback data indicating that the purchase has been declined

 {
        "account": {
            "number": "431422******0056"
        },
        "customer": {
            "id": "964282"
        },
        "payment": {
            "date": "2019-08-06T12:57:03+0000",
            "id": "10906183900",
            "method": "etoken",
            "status": "decline",
            "sum": {
                "amount": 1030000,
                "currency": "USD"
            },
            "type": "purchase",
            "description": "test"
        },
        "project_id": 312,
        "country": "GB",
        "product_name": "Visa Rewards",
        "issuer_name": "Example Bank",
        "operation": {
            "id": 45047000000055,
            "type": "sale",
            "status": "decline",
            "date": "2019-08-06T12:57:03+0000",
            "created_date": "2019-08-06T12:57:00+0000",
            "request_id": "f92c3dfdf76133d5e1a9d26279b3b77b7da32e",
            "sum_initial": {
                "amount": 1030000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1030000,
                "currency": "USD"
            },
            "provider": {
                "id": 1187,
                "payment_id": "5cb2f2fb-e4df-4807-8839-067f9366d506",
                "auth_code": ""
            },
            "code": "10105",
            "message": "Insufficient funds on card"
        },
        "signature": "9CIXvWMsKOcQsWEHKLsSVSRo8YNjIxHPjEEQSmLAtClQ=="
    }
}

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchases by using Gate

General information

To process a purchase through Gate by using the Apple Pay method, the merchant's web service is required to do the following:

  1. Send a request for starting payment session with all the required parameters and signature to the ecommpay URL.
  2. Receive customer and payment session data in an intermediate callback.
  3. Send a purchase request with all the required parameters and signature to the ecommpay URL.
  4. Get the final callback with the payment result from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure: Purchase processing by using Gate: step-by-step description

  1. A customer initiates a purchase by using the Apple Pay method in the web service.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The request for starting the payment session is redirected to the Apple Pay service.
  6. The request for starting the payment session is processed on the Apple Pay service side.
  7. The payment platform receives the payment session data from the Apple Pay service.
  8. The payment platform sends the callback with the data for starting the payment session to the web service.
  9. The web service initiates the payment session and displays the Apple Pay app or interface for purchase confirmation to the customer.
  10. The customer completes all required payment steps and confirms the purchase.
  11. The customer data is processed on the Apple Pay service side.
  12. The customer is redirected to the web service loading page.
  13. The web service receives encrypted customer data from the Apple Pay service.
  14. The web service sends the request for purchase processing to the specified ecommpay URL.
  15. The payment platform receives the request for processing the payment.
  16. The payment platform validates the required parameters and signature in the request.
  17. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  18. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the card organisation service.
  19. The request is processed on the card organisation service side.
  20. The card organisation service sends the payment result notification to the payment platform.
  21. The payment platform sends the payment result callback to the web service.
  22. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the Apple Pay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format for starting the payment session

There are several things you need to consider when sending requests for starting the payment session by using the Apple Pay method:

  1. To start each session, send a separate POST request to the /v2/session/applepay.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • validation_url—URL for validation
      • domain_name—domain name of the merchant web service
      • display_name—the name of the project to display, must contain no more than 64 characters
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)

Figure: Example of a request for starting the payment session

{
  "general" : {
    "project_id": 175,
    "signature": "VJ/h5ogVuQ6oMNLLxvvKeYBT6o+Se5mDLXHChlDZrjJX...==",
    "validation_url": "https://apple-pay-gateway.apple.com/paymentservices/startSession",
    "domain_name": "appay.eu.ngrok.io",
    "display_name": "test payment"
  }
}

Purchase request format

There are several things you need to consider when sending purchase requests by using the Apple Pay method:

  1. To initiate each purchase, send a separate POST request to one of the following endpoints:
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
    • etoken— information about token that represents card details received from the Apple Pay service:
      • token—token received from Apple Pay in JSON format after user identification, must be specified as a string. The value of this parameter can contain such information as the payment identifier on the Apple Pay side, the type of the international payment system, and various service data.

        Figure: An example of a JSON structure for a token that should be specified as a string

        {
           "paymentData":{
              "version":"EC_v1",
              "data":"perkYfGgfMXL/lTG DCSDfR7x4Qz2E/p7WZqBBJJ+/z2iWUIEBNDsovnwhwTeVXAAAAAAAA==",
              "header":{
                 "ephemeralPublicKey":"MWnwEQ==",
                 "publicKeyHash":"tl+QgkoijbTvIomdnCLsdfbvwauh5656we9wvth2+1w=",
                 "transactionId":"u85785def5ce96a8ada846sre2v6r6yry5htj93e50152"
              }
           },
           "paymentMethod":{
              "displayName":"Visa 1005",
              "network":"Visa",
              "type":"debit"
           },
           "transactionIdentifier":"TFDG767HGSFDSJ7AL4435393E5882652"
        }

        Figure: An example of the value of the token parameter as a string

        "token": "{"paymentData":{"version":"EC_v1","data":"perkYfGgfMXL/lTGDCSDfR7x4Qz2E/p7WZqBBJJ+/z2iWUIEBNDsovnwhwTeVXAAAAAAAA==","header":{"ephemeralPublicKey":"MWnwEQ==","publicKeyHash":"tl+QgkoijbTvIomdnCLsdfbvwauh5656we9wvth2+1w=","transactionId":"u85785def5ce96a8ada846sre2v6r6yry5htj93e50152"}},"paymentMethod":{"displayName":"Visa 1005","network":"Visa","type":"debit"},"transactionIdentifier":"TFDG767HGSFDSJ7AL4435393E5882652"}"
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Apple Pay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and IP address, the Apple Pay token, as well as signature.

{
  "general": {
    "project_id": 580,
    "payment_id": "TEST_15427033321774",
    "signature": "96c+hWk1zweuGKwDRrl+Se5mDLXHChlDZrjJXZw7ew6ow3RpGYv4U...=="
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "id": "123"
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "etoken": {
        "token": "..."
    }
}

Figure: Example of sufficient data in a purchase request

{
  "general": {
    "project_id": 580,
    "payment_id": "TEST_15427033321774",
    "signature": "96c+hWk1zweuGKwDRrl+Se5mDLXHChlDZrjJXZw7ew6ow3RpGYv4U...=="
  },
  "customer": {
    "ip_address": "192.0.2.0",
    "id": "123"
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "etoken": {
        "token": "..."
    }
}

Two-step purchase debiting request format

There are several things you need to consider when sending debiting requests by using the Apple Pay method:

  1. To initiate each debiting, send a separate POST request to the /v2/payment/applepay/capture endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
  3. The amount and currency must match the values in the authorisation request.
  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Apple Pay method must contain the project identifier, basic payment information (identifier, amount, and currency code), as well as signature.

{
  "general": {
    "project_id": 580,
    "payment_id": "TEST_15427033321774",
    "signature": "96c+hWk1zweuGKLXHChlDZrjJXZw7ew6ow3RpGYv4U...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  }

Figure: Example of sufficient data in a debiting request

{
  "general": {
    "project_id": 580,
    "payment_id": "TEST_15427033321774",
    "signature": "96c+hWk1zweuGKrjJXZw7ew6ow3RpGYv4U...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  }

Two-step purchase cancellation request format

There are several things you need to consider when sending purchase cancellation requests by using the Apple Pay method:

  1. To initiate each cancellation, send a separate POST request to the /v2/payment/applepay/cancel endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Apple Pay method must contain the project and payment identifiers, as well as signature.

{
  "general": {
    "project_id": 580,
    "payment_id": "TEST_15427033321774",
    "signature": "9DRrl+Se5mDLXHChlDZrjJXZw7ew6ow3RpGYv4U...=="
  }

Figure: Example of sufficient data in a purchase cancellation request

{
  "general": {
    "project_id": 580,
    "payment_id": "TEST_15427033321774",
    "signature": "9DRrl+Se5mDLXHChlDZrjJXZw7ew6ow3RpGYv4U...=="
  }

Callback format

The Apple Pay method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The callbacks containing information about processed purchases include the token of the card in the token parameter of the account object, which can only be used for initiating payouts.

The following is the example of a callback with information about a 1,000.00 USD purchase made in the 580 project.

Figure: Example of callback data indicating that the purchase has been processed

{
        "project_id": 580,
        "payment": {
            "id": "ECT_TEST_15671726468667687",
            "type": "purchase",
            "status": "success",
            "date": "2019-08-30T13:58:12+0000",
            "method": "etoken",
            "sum": {
                "amount": 100000,
                "currency": "USD"
            },
            "description": "ECT_TEST_1567172646866"
        },
        "account": {
            "number": "431422******0056"
        },
        "operation": {
            "id": 47478000001698,
            "type": "sale",
            "status": "success",
            "date": "2019-08-30T13:58:12+0000",
            "created_date": "2019-08-30T13:58:06+0000",
            "request_id": "0a5cb476be3a55010fb050ec1c1cbd35361ac912a3",
            "sum_initial": {
                "amount": 100000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 100000,
                "currency": "USD"
            },
            "provider": {
                "id": 1187,
                "payment_id": "24fb3f30-000f-5000-8000-1c329d900c68",
                "date": "2019-08-30T13:58:09+0000",
                "auth_code": "591748"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "5DtWEGy+dMGZZnm3Owjgw9ly67Mb9siv7+WD1u7AyIYdQ=="
    }
}

The following is the example of a callback for a purchase declined due to insufficient funds on card.

Figure: Example of callback data indicating that the purchase has been declined

 {
        "account": {
            "number": "431422******0056"
        },
        "customer": {
            "id": "964282"
        },
        "payment": {
            "date": "2019-08-06T12:57:03+0000",
            "id": "10906183900",
            "method": "etoken",
            "status": "decline",
            "sum": {
                "amount": 1030000,
                "currency": "USD"
            },
            "type": "purchase",
            "description": "test"
        },
        "project_id": 312,
        "country": "GB",
        "product_name": "Visa Rewards",
        "issuer_name": "Example Bank",
        "operation": {
            "id": 45047000000055,
            "type": "sale",
            "status": "decline",
            "date": "2019-08-06T12:57:03+0000",
            "created_date": "2019-08-06T12:57:00+0000",
            "request_id": "f92c3dfdf76133d5e1a9d26279b3b77b7da32e",
            "sum_initial": {
                "amount": 1030000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1030000,
                "currency": "USD"
            },
            "provider": {
                "id": 1187,
                "payment_id": "5cb2f2fb-e4df-4807-8839-067f9366d506",
                "auth_code": ""
            },
            "code": "10105",
            "message": "Insufficient funds on card"
        },
        "signature": "9CIXvWMsKOcQsWEHKLsSVSRo8YNjIxHPjEEQSmLAtClQ=="
    }
}

Useful links

The following articles can be useful when implementing purchases via Gate:

COF purchases by using Payment Page

General information

The Apple Pay payment method provides the ability to perform COF purchases—regular on-demand payments. For more information about COF purchases, see On-demand COF purchase.

Registration of a COF purchases is also available by using Payment Page. For registration the web service must send a request containing the required parameters and signature, as well as data for registering a COF purchase in the recurring object, to the ecommpay URL and accept a callback with the result. In the callback about registering a COF purchase, you will get its ID, which you need to use to make or cancel regular payments via Gate or Dashboard. For more information, see the section COF purchases by using Gate.

Information about the formats of requests and callbacks used for processing payments by using the Apple Pay method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests for registering COF purchases by using the Apple Pay method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. To register a COF purchase, you must specify a recurring object containing the registration attribute and the necessary information. To register regular payments, the request must contain information about the frequency, amount, and beginning and end time of regular payments. The full list of parameters that can be passed in the recurring object is shown in the COF purchase registration section.
  4. If you need to have payment form displayed with the Apple Pay method selected, set the force_payment_method parameter to:
    • apple_pay_core—to open Payment Page with pre-selected payment method Apple Pay
    • card—for the ability of payment by using either a payment card or Apple Pay. In this case customer can chose the payment method on Payment Page
  5. Additionally, any other parameters available for working with Payment Page can be used (details).
  6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Apple Pay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 100000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "recurring": {"register":true,"type":"R","expiry_year":2025,"expiry_month":"01","period":"D","time":"10:00:00","start_date":"15-11-2020","scheduled_payment_id":"A2323"},
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Figure: Example of sufficient data in a COF purchase request

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 100000,
   "payment_currency": "USD",
   "customer_id": "customer1",
   "recurring": {"register":true,"type":"R","expiry_year":2025,"expiry_month":"01","period":"D","time":"10:00:00","start_date":"15-11-2020","scheduled_payment_id":"A2323"},
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The Apple Pay method uses the standard format for callbacks to deliver COF purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a successful COF purchase registration made by a customer in the 208 project.

Figure: Example of callback data indicating that the COF purchase has been registered

 {
        "project_id": 208,
        "payment": {
            "id": "payment",
            "type": "purchase",
            "status": "success",
            "date": "2018-11-20T08:44:46+0000",
            "method": "etoken",
            "sum": {
                "amount": 300,
                "currency": "USD"
            },
            "description": "payment"
        },
        "account": {
            "number": "431422******0056"
        },
        "recurring": {
            "id": 1000030038,
            "currency": "USD",
            "valid_thru": "-0001-11-30T00:00:00+0000"
        },
        "operation": {
            "id": 1000034,
            "type": "recurring",
            "status": "success",
            "date": "2018-11-20T08:44:46+0000",
            "created_date": "2018-11-20T08:44:41+0000",
            "request_id": "07fd7ade7cf010",
            "sum_initial": {
                "amount": 300,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "USD"
            },
            "provider": {
                "id": 1381,
                "payment_id": "2548950091",
                "date": "2020-11-20T08:44:45+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "x2tsnvLCRXZMX8Kwyr9a8+I3RipuPWUod5c89cDSQ6cRq...=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

COF purchases by using Gate

General information

The Apple Pay payment method provides the ability to perform COF purchases—regular on-demand payments. For more information about COF purchases, see On-demand COF purchase.

Information about the formats of requests and callbacks used for processing payments by using the Apple Pay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

COF purchase registration

To register a COF purchase by using Gate, the merchant is required to send a request for purchase with all the required parameters (including the register parameter of the recurring object, set to the value true) to the ecommpay URL and get the callback with the payment result from the payment platform. To register a regular payment the request should also contain information about the frequency, amount, start and end dates of regular payments. The COF purchase registration callback contains its identifier, which can be used to process or cancel regular payments.

For more information about purchase processing by using Gate, see Purchases by using Gate.

Format of requests for registration of COF purchases

There are several things you need to consider when sending requests for registering COF purchases by using the Apple Pay method:

  1. To register each COF purchase, send a separate POST request to one of the following endpoints: /v2/payment/applepay/sale or /v2/payment/applepay/auth.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
    • Object recurring—COF purchase information:
      • register—payment registration as a COF purchase
      • type—type of the COF purchase: R (for Regular payment), C (for OneClick payment), or U (for Autopayment), for more information, refer to Overview
      • scheduled_payment_id—identifier of the next COF purchase
      • start_date—the start date of regular payments, in the DD-MM-YYYY format (must be at least one day later than the date of registration)
      • amount—amount of debiting
      • period—regular payment performing period
      • interval— regular payment performing interval
      • time—regular payment performing time in the hh:mm:ss (UTC0) format
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct COF purchase registration request by using the Apple Pay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and IP address, the registration parameter and the conditions for regular payments, as well as signature.

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytQ6/ZtDSQh+wwx/OqrWdbltzO5GMSkzd0Iq6lM2...==",
  },
  "customer": {
    "id": "123",
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "recurring": {
    "register": true,
    "type": "R",
    "amount": 1000,
    "interval": 1,
    "cycle": "week",
    "start_date": "21-11-2018"
  }
}

Figure: Example of sufficient data in a COF purchase registration request

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytQ6/ZtDSQh+wwx/OqrWdbltzO5GMSkzd0Iq6lM2...==",
  },
  "customer": {
    "id": "123",
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "recurring": {
    "register": true,
    "type": "R",
    "amount": 1000,
    "interval": 1,
    "cycle": "week",
    "start_date": "21-11-2018"
  }
}

Format of requests for COF purchase processing

After the payment is registered, the funds are debited according to the specified regular payment conditions. You initiate COF purchase by sending a recurring request to the payment platform.

There are several things you must consider when processing COF purchases performing by using the Apple Pay method:

  1. To process each purchase, send a separate POST request to the /v2/payment/applepay/recurring endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • ip_address—customer IP address relevant for the initiated payment
    • Object recurring—COF purchase information:
      • id—registered COF purchase identifier
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Apple Pay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer IP address, COF purchase identifier, as well as signature.

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytQ6wx/OqrWdbltzO5GMSkzd0Iq6lM2...==",
  },
  "customer": {
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "recurring": {
    "id": 1234567890
  }
}

Figure: Example of sufficient data in a COF purchase processing request

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytQ6wx/OqrWdbltzO5GMSkzd0Iq6lM2...==",
  },
  "customer": {
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "recurring": {
    "id": 1234567890
  }
}

Format of request for cancellation of COF purchases

Until the expiration date of a COF purchase, you can cancel it. Also, to change the conditions of COF purchases, you must cancel it and send a request to register a new one.

There are several things you must consider when cancelling COF purchases by using the Apple Pay method:

  1. To cancel each purchase, send a separate POST request to the /v2/payment/applepay/recurring/cancel endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object recurring—COF purchase information:
      • id—registered COF purchase identifier
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Apple Pay method must contain the project, payment and COF purchase identifiers, as well as signature.

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytQ6/ZtDzO5GMSkzd0Iq6lM2v8...==",
  },
  "recurring": {
    "id": 1234567890
  }
}

Figure: Example of sufficient data in a COF purchase cancellation request

 {
  "general": {
    "project_id": 208,
    "payment_id": "TEST_15427007172789",
    "signature": "DH0v2pZnkK9hwytQ6/ZtDzO5GMSkzd0Iq6lM2v8...==",
  },
  "recurring": {
    "id": 1234567890
  }
}

Callback format

The standard format for callbacks is used to deliver the results of actions with COF purchases. For more information, see Callbacks.

The following is the example of a callback with an information about COF purchase registration for a customer in the 208 project.

Figure: Example of callback data indicating that the COF purchase has been registered

 {
        "project_id": 208,
        "payment": {
            "id": "payment",
            "type": "recurring",
            "status": "success",
            "date": "2018-11-20T08:44:46+0000",
            "method": "etoken",
            "sum": {
                "amount": 300,
                "currency": "USD"
            },
            "description": "payment"
        },
        "account": {
            "number": "431422******0056"
        },
        "recurring": {
            "id": 1000030038,
            "currency": "USD",
            "valid_thru": "-0001-11-30T00:00:00+0000"
        },
        "operation": {
            "id": 1000034,
            "type": "recurring",
            "status": "success",
            "date": "2018-11-20T08:44:46+0000",
            "created_date": "2018-11-20T08:44:41+0000",
            "request_id": "07fd7ade7cf010",
            "sum_initial": {
                "amount": 300,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "USD"
            },
            "provider": {
                "id": 1381,
                "payment_id": "2548950091",
                "date": "2020-11-20T08:44:45+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "x2tsnvLCRXZMXr9a8+I3RipuPWUod5c89cDSQ6cRq...=="
    }

The following is the example of a callback after COF purchase cancellation.

Figure: Example of callback data indicating that the COF purchase has been cancelled

 {
        "project_id": 208,
        "payment": {
            "id": "payment",
            "type": "recurring",
            "status": "success",
            "date": "2018-11-20T08:44:46+0000",
            "method": "etoken",
            "sum": {
                "amount": 300,
                "currency": "USD"
            },
            "description": "payment"
        },
        "account": {
            "number": "431422******0056"
        },
        "recurring": {
            "id": 1000030038,
            "currency": "USD",
            "valid_thru": "-0001-11-30T00:00:00+0000"
        },
        "operation": {
            "id": 1000034,
            "type": "recurring_cancel",
            "status": "success",
            "date": "2018-11-20T08:44:46+0000",
            "created_date": "2018-11-20T08:44:41+0000",
            "request_id": "07fd7ade7cf010",
            "sum_initial": {
                "amount": 300,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "USD"
            },
            "provider": {
                "id": 1381,
                "payment_id": "2548950091",
                "date": "2020-11-20T08:44:45+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "x2tsnvLCRXZMX8Kwyr9a8+I3RipuPWUod5c89cDSQ6cRq...=="
    }

The following is the example of a callback with an information about a declined registration of a COF purchase.

Figure: Example of callback data indicating that the COF purchase registration has been declined

 {
        "project_id": 208,
        "payment": {
            "id": "payment",
            "type": "recurring",
            "status": "success",
            "date": "2018-11-20T08:44:46+0000",
            "method": "etoken",
            "sum": {
                "amount": 300,
                "currency": "USD"
            },
            "description": "payment"
        },
        "errors": [
            {
                "code": "2701",
                "message": "Rules Failed Code",
                "description": "fatal: RULES_FAILED_CODE"
            }
        ],
        "recurring": {
            "id": 1000700,
            "currency": "USD",
            "valid_thru": "-0001-11-30T00:00:00+0000"
        },
        "operation": {
            "id": 1000034,
            "type": "recurring",
            "status": "decline",
            "date": "2018-11-20T08:44:46+0000",
            "created_date": "2018-11-20T08:44:41+0000",
            "request_id": "07fd7ade7cf010",
            "sum_initial": {
                "amount": 300,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 300,
                "currency": "USD"
            },
            "provider": {
                "id": 1381,
                "payment_id": "2548950091",
                "date": "2020-11-20T08:44:45+0000",
                "auth_code": ""
            },
            "code": "2701",
            "message": "Rules Failed Code"
        },
        "signature": "x2tsnvLCRXZMX8Kwyr9a8+I3RipuPWUod5c89cDSQ6cRq...=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

Refunds by using Gate

General information

To perform a refund through Gate by using the Apple Pay method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of refund performing are provided below.



Figure: Refund performing by using Gate: step-by-step description

  1. A customer initiates a refund.
  2. The web service sends the request for performing the refund by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the card organisation service.
  7. The refund is processed on the side of the card organisation service.
  8. The card organisation service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the refund result information from the web service.

Information about the formats of requests and callbacks used for performing refunds by using the Apple Pay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending refund requests by using the Apple Pay method:

  1. To initiate each refund, send a separate POST request to the /v2/payment/applepay/refund endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general refund information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_ididentifier of the payment that needs to be refundedpayment identifier
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification)
    • Object payment—refund information:
      • description—refund description or comment
      • amount—refund amount in the smallest currency unit (required for a partial refund)
      • currency—refund currency code in the ISO-4217 alpha-3 format (required for a partial refund)
    • Object customer—customer information:
      • ip_address—customer IP address relevant for the initiated refund
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct refund request by using the Apple Pay method must contain the project and payment identifiers, description of the refund, the customer IP address, signature, and, if necessary, currency code and refund amount.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "USD"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

Figure: Example of sufficient data in a refund request

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "description": "test refund",
    "amount": 1000,
    "currency": "USD"
  },
  "customer": {
    "ip_address": "192.0.2.0"
  }
}

Callback format

The Apple Pay method uses the standard format for callbacks to deliver refund results. For more information, see Callbacks.

The following is the example of a callback with information about a 10,00 USD refund made in the 260 project.

Figure: Example of callback data indicating that the refund has been processed

{
        "project_id": 260,
        "payment": {
            "id": "TEST_15792507735",
            "type": "purchase",
            "status": "refunded",
            "date": "2020-01-20T08:31:36+0000",
            "method": "etoken",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": ""
        },
        "customer": {
            "id": "1888"
        },
        "account": {
            "number": "431422******0056"
        },
        "operation": {
            "id": 69512000019571,
            "type": "refund",
            "status": "success",
            "date": "2020-01-20T08:31:36+0000",
            "created_date": "2020-01-20T08:31:35+0000",
            "request_id": "e0069513"
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1911,
                "payment_id": "0000438583",
                "auth_code": ""
                }
            },
        "signature": "beJ1deUiEDd+7zuo6YrfSRzgEQj34sKAStuW8Fg=="
    }

The following is the example of a callback with information about a declined refund.

Figure: Example of callback data indicating that the refund has been declined

{
        "project_id": 260,
        "payment": {
            "id": "TEST_1579250773501",
            "type": "purchase",
            "status": "success",
            "date": "2020-01-20T08:31:36+0000",
            "method": "etoken",
            "sum": {
                "amount": 100,
                "currency": "USD"
            },
            "description": ""
        },
        "customer": {
            "id": "1888"
        },
        "account": {
            "number": "431422******0056"
        },
        "operation": {
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "3283",
            "message": "Refund amount more than init amount",
            "provider": {
                "id": 1911,
                "payment_id": "0000438582",
                "auth_code": ""
            },
            "id": 69512000019571,
            "type": "refund",
            "status": "decline",
            "date": "2020-01-20T08:31:36+0000",
            "created_date": "2020-01-20T08:31:35+0000",
            "request_id": "e0069142"
        },
        "signature": "beJ1deUiEDd+7zuooJzgEQj34sKAStuW8Fg=="
    }
}

Useful links

The following articles can be useful when implementing refunds via Gate:

Payouts by using Gate

General information

To process a payout through Gate by using the Apple Pay method, send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of payout processing are provided below.



Figure: Payout processing by using Gate: step-by-step description

  1. A customer initiates a payout by using the Apple Pay method in the web service.
  2. The web service sends the request for processing the payout by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the card organisation service.
  7. The payout is processed on the side of the card organisation service.
  8. The card organisation service sends the result notification to the payment platform.
  9. The payment platform sends the result callback to the web service.
  10. The customer receives the payout result information from the web service.

Information about the formats of requests and callbacks used for processing payouts by using the Apple Pay method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending payout requests by using the Apple Pay method:

  1. To initiate each payout send a separate POST request to the /v2/payment/card/payout/token endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general payout information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) details
    • Object payment—payment information:
      • amount—payout amount in the smallest currency unit
      • currency—payout currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • first_name—customer first name
      • middle_name—customer middle name or patronymic
      • last_name—customer last name
      • ip_address—customer IP address relevant for the initiated payout
    • Object card—card information:
      • card_holder—full name of the cardholder
    • token—token of the card received from ecommpay in the parameter included in a callback informing about a processed purchase.
  3. In the case of a payout to Visa card issued in Canada, the request must contain the recipient object with the payout recipient's address data:
    • country—recipient's country code in ISO 3166-1 alpha-2
    • city—recipient's city
    • address—recipient's address
    • if the specified country code is CA or US, also pass the state parameter that provides information about the recipient's state, province, or any other region
  4. In the case of a payout processed as part of the Visa Money Transfer program to a card issued in Brazil or Qatar, the request must contain the sender's phone number in the phone parameter of the sender object.
  5. In the case of a payout that originates from a physical person and that is processed as part of the programs supported for the Mastercard MoneySend service, the request must contain the information about the payout recipient's name in the first_name and last_name parameters of the recipient object and the information about the payout sender in the sender object:
    • number of the sender's payment instrument—pan for the sender's card or wallet_id for the sender's electronic wallet
    • first_name—sender's first name
    • last_name—sender's last name
    • address—sender's address
    • city—sender's city
    • zip—sender's postal code
    • country—sender's country code in ISO 3166-1 alpha-2
    • if the specified country code is CA or US, also pass the state parameter that provides information about the sender's state, province, or any other region
  6. Additionally, any other parameters included in the specification can be used.

Thus, a correct payout request by using the Apple Pay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, as well as token and signature.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "customer": {
    "id": "customer123",
    "first_name": "John",
    "middle_name": "Jr",
    "last_name": "Jonson",
    "ip_address": "192.0.2.0"
  },
  "card": {
    "card_holder": "John Johnson",
  "token": "a989f5ef7ab159dd5c3016eee7563736f"
  }
}

Figure: Example of sufficient data in a payout request

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "USD"
  },
  "customer": {
    "id": "customer123",
    "first_name": "John",
    "middle_name": "Jr",
    "last_name": "Jonson",
    "ip_address": "192.0.2.0"
  },
  "card": {
    "card_holder": "John Johnson",
  "token": "a989f5ef7ab159dd5c3016eee7563736f"
  }
}

Callback format

The Apple Pay method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks.

The following is the example of a callback with information about a 1.00 EUR payout made in the 123 project.

Figure: Example of callback data indicating that the payout has been processed

{
        "payment": {
            "method": "card",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "id": "test_id",
            "type": "payout",
            "status": "success",
            "date": "2023-11-07T07:37:27+0000",
            "description": "Test payout"
        },
        "customer": {
            "id": "Test",
            "ip": "192.0.2.0",
            "first_name": "Test",
            "last_name": "Test"
        },
        "account": {
            "number": "1234******4567",
            "token": "a9608ce50413260e4201d13dbfcdc75",
            "type": "visa",
            "card_holder": "TEST TEST",
            "expiry_month": "01",
            "expiry_year": "2031"
        },
        "project_id": 123,
        "rrn": "331140338636",
        "testdebet": "credit",
        "opeation": {
            "last_processor_message": "Success"
        },
        "operation": {
            "created_date": "2023-11-07T07:37:22+0000",
            "request_id": "d22a4c02f61ed9a82140045-00049491",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 414,
                "payment_id": "0040000018267721",
                "auth_code": "408112",
                "endpoint_id": 414,
                "date": "2023-11-07T07:37:24+0000"
            },
            "id": 49490010084733,
            "type": "payout",
            "status": "success",
            "date": "2023-11-07T07:37:27+0000"
        },
        "signature": "TL2BLpOE/xAVCmYf8SIUXYqmlF1WHtaHQ=="
    }

The following is the example of a callback with information about a declined payout.

Figure: Example of callback data indicating that the payout has been declined

{
        "payment": {
            "method": "card",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "id": "test_id",
            "type": "payout",
            "status": "decline",
            "date": "2023-11-07T07:38:27+0000",
            "description": "Test payout"
        },
        "customer": {
            "id": "Test",
            "ip": "192.0.2.0",
            "first_name": "Test",
            "last_name": "Test"
        },
        "account": {
            "number": "1234******4567",
            "token": "a9608ce50413260e4201d13dbfcdc75",
            "type": "visa",
            "card_holder": "TEST TEST",
            "expiry_month": "01",
            "expiry_year": "2031"
        },
        "project_id": 123,
        "rrn": "",
        "testdebet": "credit",
        "opeation": {
            "last_processor_message": "Decline"
        },
        "operation": {
            "created_date": "2023-11-07T07:38:22+0000",
            "request_id": "d22a4c02f61ed9a82140045-00049492",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 414,
                "payment_id": "0040000018267721",
                "auth_code": "",
                "endpoint_id": 414,
                "date": "2023-11-07T07:38:24+0000"
            },
            "id": 49490010084733,
            "type": "payout",
            "status": "decline",
            "date": "2023-11-07T07:38:27+0000"
        },
        "signature": "TL2BLpOE/xAVCmYf8SIUXYqmlF1WHtaHA=="
    }

Useful links

The following articles can be useful when implementing payouts via Gate:

Payouts by using Dashboard

When working with Dashboard, you can process payouts by using the Apple Pay method using batch requests. Each batch can contain one or more payout requests.

To process a number of payouts, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information about processing payouts by using Dashboard is presented in a separate section.

Payment card verification

General information

To perform a payment card verification by using Apple Pay method, the merchant web service must send a request with all the required parameters and signature to ecommpay URL, and receive a callback with the information about the result. Payment card verification processing for this method is the same as standard processing sequence which is provided in the section Payment instrument verification.

Format of request for payment card verification

There are several things you need to consider when sending payment card verification requests by using the Apple Pay method:

  1. To initiate each verification, send a separate POST request to the /v2/payment/applepay/account_verification endpoint.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
    • etoken— information about token that represents card details received from the Apple Pay service:
      • token—token received from Apple Pay in JSON format after user identification, must be specified as a string. The value of this parameter can contain such information as the payment identifier on the Apple Pay side, the type of the international payment system, and various service data.

        Figure: An example of a JSON structure for a token that should be specified as a string

        {
           "paymentData":{
              "version":"EC_v1",
              "data":"perkYfGgfMXL/lTG DCSDfR7x4Qz2E/p7WZqBBJJ+/z2iWUIEBNDsovnwhwTeVXAAAAAAAA==",
              "header":{
                 "ephemeralPublicKey":"MWnwEQ==",
                 "publicKeyHash":"tl+QgkoijbTvIomdnCLsdfbvwauh5656we9wvth2+1w=",
                 "transactionId":"u85785def5ce96a8ada846sre2v6r6yry5htj93e50152"
              }
           },
           "paymentMethod":{
              "displayName":"Visa 1005",
              "network":"Visa",
              "type":"debit"
           },
           "transactionIdentifier":"TFDG767HGSFDSJ7AL4435393E5882652"
        }

        Figure: An example of the value of the token parameter as a string

        "token": "{"paymentData":{"version":"EC_v1","data":"perkYfGgfMXL/lTGDCSDfR7x4Qz2E/p7WZqBBJJ+/z2iWUIEBNDsovnwhwTeVXAAAAAAAA==","header":{"ephemeralPublicKey":"MWnwEQ==","publicKeyHash":"tl+QgkoijbTvIomdnCLsdfbvwauh5656we9wvth2+1w=","transactionId":"u85785def5ce96a8ada846sre2v6r6yry5htj93e50152"}},"paymentMethod":{"displayName":"Visa 1005","network":"Visa","type":"debit"},"transactionIdentifier":"TFDG767HGSFDSJ7AL4435393E5882652"}"
  3. The payment amount must be zero.
  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Apple Pay method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer identifier and IP address, Apple Pay token information, as well as signature.

{
  "general": {
    "project_id": 238,
    "payment_id": "TEST_15427033321774",
    "signature": "96c+hWk1zweuGKwDRrl+DZrjJXZw7ew6ow3RpGYv4U...=="
  },
  "customer": {
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 0,
    "currency": "USD"
  },
  "etoken": {
        "token": "..."
    }
}

Figure: Example of sufficient data in a card verification request

{
  "general": {
    "project_id": 238,
    "payment_id": "TEST_15427033321774",
    "signature": "96c+hWk1zweuGKwDRrl+DZrjJXZw7ew6ow3RpGYv4U...=="
  },
  "customer": {
    "ip_address": "192.0.2.0"
  },
  "payment": {
    "amount": 0,
    "currency": "USD"
  },
  "etoken": {
        "token": "..."
    }
}

Callback format

The Apple Pay method uses the standard format for callbacks to deliver results. For more information, see Payment instrument verification.

Useful links

The following articles can be useful when implementing purchases via Gate:

Testing

General information

For the Apple Pay method, it is possible to test one-step and two-step purchases by using Payment Page and Gate, as well as payment card verification by using Gate. To enable and disable testing, as well getting assistance with setting up a test project, refer to ecommpay technical support. When testing purchases by using Gate the web service must adhere to the following requirements:

  • The we service domain should be registered in the Apple services. For registration contact the ecommpay technical support support@ecommpay.com
  • The site supports scripting functionality to start an Apple session according to documentation

Other notes which are specified in the General information table should be taken into account when testing purchases.

When testing payments and operations keep in mind that the test project identifier must be indicated in requests, the interfaces of the emulator of Payment Page and Apple Pay payment forms, the 3‑D Secure authentication page can differ from the production environment. To avoid errors during purchase testing it is recommended to use a payment card which is already registered in the Apple Pay service. This does not influence the processing of real payments by using such cards, but allows to perform full-fledged testing.

Statuses of test payment and operations

The final status of test payments and operations is determined by the amount specified in the request.

Test one-step and two-step purchases:

  • 1000 amount to get the success status
  • 2000, 5000 or 10001 amount to get the decline status

Test payment card verification:

  • 0 amount to get the success status
  • any other amount to get the decline status

One-step purchases by using Payment Page

To perform a test one-step purchase by using Payment Page, do the following:

  1. Send a correct test request for Payment Page opening to the payment platform.
  2. If the card or apple_pay_core method was not specified in the request—select the method on the emulator page.
  3. Confirm the purchase.
  4. Receive the final callback with information about the payment result.

More information about processing purchases by using the Apple Pay method via Payment Page is provided in the Purchases by using Payment Page section.

One-step purchases by using Gate

To perform a test one-step purchase by using Gate, do the following:

  1. Send a correct test request for starting a payment session to the payment platform.
  2. Receive customer and payment session data.
  3. Confirm the purchase.
  4. Send a correct test purchase request to the payment platform.
  5. Receive the final callback with information about the payment result.

More information about processing purchases by using the Apple Pay method via Gate is provided in the Purchases by using Gate section.

One-step purchases by performing authorization hold via Payment Page and capture or cancellation via Gate

To perform a test one-step purchase by performing authorization hold via Payment Page and capture or cancellation via Gate, do the following:

  1. Send a correct test request for Payment Page opening to the payment platform.
  2. If the card or apple_pay_core method was not specified in the request—select the method on the emulator page.
  3. Confirm the purchase.
  4. Accept a callback with information about successful authorization hold.
  5. Send a capture or cancellation request.
  6. Receive the final callback with information about the result.

More information about processing purchases by using the Apple Pay method via Gate is provided in the Purchases by using Payment Page and Purchases by using Gate sections.

One-step purchases by performing authorization hold and capture or cancellation via Gate

To perform a test one-step purchase by performing authorization hold and capture or cancellation via Gate, do the following:

  1. Send a correct test request for starting a payment session to the payment platform.
  2. Receive customer and payment session data.
  3. Send a correct test purchase request to the payment platform.
  4. Confirm the purchase.
  5. Accept a callback with information about successful authorization hold.
  6. Send a capture or cancellation request.
  7. Receive the final callback with information about the result.

More information about processing purchases by using the Apple Pay method via Gate is provided in the Purchases by using Gate section.

Payment card verification by using Gate

To process a test payment card verification by using Gate, send a valid test request for a verification to the payment platform and receive a final callback with information about the verification result. More information about performing payment card verification by using the Apple Pay method via Gate is provided in the Payment card verification section.

Analysis of payments results

To analyse information about payments made with the Apple Pay method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.