Create Transaction

Create a transaction with an Apple Pay wallet payload.

Response Codes
102 - Idempotent matched request currently processing
201 - Created, will include a Location response header
200 - Request Succeeded, but entity not created
400 - Bad Request, missing or invalid parameters
409 - Idempotent matched request already processed
422 - Request not process due to business constraints
502 - Bad gateway response from Apple
503 - Apple Pay unavailable


Error Codes

These are possible error codes for the Apple Pay specific transaction flow. The Create Card Account, Card Account Validation, and Create Transaction errors all apply to this endpoint.

Error codeWhen
ERR_DIGITAL_WALLET_PAYLOAD_INVALIDThe Apple payment data is missing or malformed, an unsupported version or type generated from the digital wallet.
ERR_DIGITAL_WALLET_TOKEN_EXPIREDApple signed the token more than 5 minutes before (or after) Interchecks received it. Send the token within 5 minutes of the user authorizing the payment; otherwise the user must authorize again.
ERR_DIGITAL_WALLET_NO_MATCHING_CERTIFICATEApple's signature is valid, but the token is encrypted to a payment processing certificate that Interchecks does not hold in this environment. It can indicate the merchant session did not come from the Merchant Validation endpoint, or the token was created against a different environment.
ERR_DIGITAL_WALLET_DECRYPTION_FAILEDApple's signature is valid and the certificate matched, but token decryption failed.
ERR_DIGITAL_WALLET_INTERNAL_ERRORUnexpected failure processing the token, including a decrypted token that has no card number.
ERR_APPLE_PAY_NOT_ENABLEDThe client is not enabled for Apple Pay.
ERR_INVALID_CURRENCY_CODEThe currency in Apple's token is not USD.
ERR_INVALID_EXP_DATEThe card expiry in Apple's token is invalid or already past. Same as the existing card-add flow.
ERR_INVALID_ADDRESS_PARAMETERSThe billing address is not a valid US address.
• administrativeArea is not a US state abbreviation, for example Massachusetts instead of MA.
• The first addressLines entry is blank.
• The street lines, locality or postalCode contain non-ASCII characters, such as accented letters.
ERR_INVALID_CARD_DETAILS, ERR_CARD_INELIGIBLE, ERR_CREDIT_CARD_NOT_SUPPORTED, ERR_PREPAID_CARD_NOT_SUPPORTEDThe card fails the payer's card eligibility rules (card type, network, BIN). Same as the existing card-add flow; the error is returned in the response body with HTTP 200.

Idempotency

The Apple Pay transaction endpoint enforces the idempotency-key header, if included, in addition to evaluating the transactionIdentifer in the apple_pay_data object. A 102 or 409 status code could reference either idempotent solution.

Combined Operations

Interchecks will process payload contents to evaluate card account eligibility and verification, including name and address. After a card account passes the necessary checks, it will be used to initiate a card transaction.

Review the endpoints below for success and error scenarios.

Create Card Account
Verify Card Account
Create Transaction



Path Params
string
required
Body Params
string
required

Recipient ID

string
string
enum
required

Transaction method

Allowed:
string
enum
required

Direction of funds - CREDIT funds to Recipient or DEBIT funds from Recipient

Allowed:
location
object
required

Possibly required for compliance purposes

json
required
json

JSON string of values to include for reporting requirements. Please consult with technical team on usage.

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json