1. Alternative Payment Methods
Sipay API Documentation - ZA
  • Overview
    • Getting Started
    • Test Cards
  • Authentication
    • Token Generation
      POST
  • Commission
    • Commission
      POST
  • HASH
    • Hash Creation
    • Hash Validation
  • Non-Secure Payment
    • Non-Secure Payment Flow
    • Non-Secure Card Payment
      POST
    • Non-Secure Pre-Authorization Payment
      POST
    • Confirm Payment
      POST
  • 3D Secure Payment
    • 3D Secure Payment Flow
    • 3D Secure Card Payment
      POST
    • 3D Secure Pre-Authorization Payment
      POST
    • Complete Payment
      POST
    • Confirm Payment
      POST
  • Non-Secure and 3D Payment with Sipay
    • Non-Secure and 3D Secure Payment with Sipay
  • Check Status
    • Check Status
  • Refund
    • Refund
  • Webhook
    • Webhook
  • Status Codes
    • Status Codes
  • Alternative Payment Methods
    • Overview
    • Payment Flow
    • Base URL & Environments
    • Hash Key
    • Client-side SDK handling
    • Status Codes
    • End-to-end example
    • GPay Payment Example
    • Authentication
      POST
    • walletCheckout
      POST
    • walletPay
      POST
  1. Alternative Payment Methods

walletCheckout

Testing
POST
/ccpayment/api/walletCheckout
Initializes a wallet payment session and returns a self-executing JavaScript snippet that renders the wallet button on the checkout page.
On success the response Content-Type is application/javascript — the body is executable JavaScript, not JSON.
Inject it into your checkout page (e.g. append it as a script or eval it after fetching). The script:
1.
loads the wallet payment SDK.
2.
waits for an element with id="walletCheckout" to exist in the DOM.
3.
mounts the Apple Pay / Google Pay button into it,
and surfaces the resulting transient token when the customer completes the wallet sheet.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/jsonRequired

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

⚪1Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://test01-app.sipay.co.za//ccpayment/api/walletCheckout' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '```json
{
  "merchant_key": "$2y$10$....",
  "hash_key": "iv:salt:ciphertext__",
  "invoice_id": "ORDER-2026-0001",
  "total": 149.90,
  "currency_code": "TRY",
  "payment_service_provider": [
    "apple_pay",
    "google_pay"
  ],
  "items": [
    {
      "name": "Premium plan",
      "price": 149.90,
      "quantity": 1,
      "description": "Annual premium subscription"
    }
  ],
  "name": "Mehmet",
  "surname": "Yilmaz",
  "bill_email": "mehmet@example.com",
  "bill_address1": "Levent Mah. No:1",
  "bill_city": "Istanbul",
  "bill_country": "TR",
  "bill_phone": "5551112233"
}
```'
Response Response Example
200 - Example 1
{}
Modified at 2026-06-02 14:22:08
Previous
Authentication
Next
walletPay
Built with