---
title: "Link Apple Pay Card"
method: POST
path: "/withdraw/apple-pay"
tags: ["withdraw"]
---

# Link Apple Pay Card

`POST /withdraw/apple-pay`

Adds an Apple Pay card to the withdrawer's account which they can push
funds to from the CF wallet.

The `ApplePayResponseObject` is decrypted and the underlying card is BIN
checked to ensure it is a debit card eligible for push-to-card. Returns the
token to pass as the `account` on the payout endpoints.

## Headers

- `x-coinflow-auth-user-id` string, required

## Request body

- AddApplePayArgs
  - `applePayPayment` ApplePayPayment, required — Apple Pay Payment received from the Apple Pay SDK Details can be found here: https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment
    - `token` ApplePayPaymentToken, required
      - `transactionIdentifier` string, required — A unique identifier for this payment.
      - `paymentMethod` ApplePayPaymentTokenPaymentMethod, required — Information about the card used in the transaction.
        - `type` '' | 'debit' | 'credit' | 'prepaid' | 'store' — A value representing the card's type of payment. Optional: Apple omits this field (or sends an empty string) for cards it does not classify, including some Amex corporate/commercial cards. Treat a missing value as unknown rather than assuming a funding type.
        - `network` union, required — A string, suitable for display, that is the name of the payment network backing the card.
          - string
          - 'Visa'
        - `displayName` string, required — A string, suitable for display, that describes the card.
      - `paymentData` ApplePayPaymentTokenPaymentData, required — An object containing the encrypted payment data.
        - `version` string, required
        - `header` ApplePayPaymentTokenPaymentDataHeader, required
          - `transactionId` string, required
          - `ephemeralPublicKey` string, required
          - `publicKeyHash` string, required
        - `signature` string, required
        - `data` string, required
    - `billingContact` ApplePayBillingContact, required
      - `givenName` string, required — The contact's given name.
      - `familyName` string, required — The contact's family name.
      - `addressLines` string[], required — The street portion of the address for the contact.
      - `locality` string, required — The city for the contact.
      - `country` string — The name of the country for the contact.
      - `emailAddress` string — An email address for the contact.
      - `postalCode` string — The zip code or postal code, where applicable, for the contact.
      - `administrativeArea` string — The state for the contact.
      - `subAdministrativeArea` string — The subadministrative area (such as a county or other region) in a postal address.
      - `countryCode` string — The contact’s two-letter ISO 3166 country code.
    - `shippingContact` PickApplePayJSApplePayPaymentContactEmailAddress — From T, pick a set of properties whose keys are in the union K
      - `emailAddress` string — An email address for the contact.
    - `decrypted` DecryptedApplePayToken
      - `applicationPrimaryAccountNumber` string, required
      - `applicationExpirationDate` string, required
      - `currencyCode` string, required
      - `transactionAmount` number, double, required
      - `deviceManufacturerIdentifier` string, required
      - `paymentDataType` string, required
      - `paymentData` PaymentData, required
        - `onlinePaymentCryptogram` string, required
        - `eciIndicator` string
  - `merchantId` string

## Response `200`

Ok

- string

---

[API](https://skmtc.net/coinflow/apis/api-reference.md) · [All operations](https://skmtc.net/coinflow/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coinflow/api-reference/revisions/c0201d849baf/schema)