createWalletAuthorization

MUTATION

This call is used to create an authorization for a wallet payment via Apple Pay or Google Pay. It works in conjunction with our SDKs to allow you to create an authorization via our API.

Arguments

app_id

String

The Pay Theory unique identifier for the application.

merchant_uidRequired

String

The Pay Theory unique identifier assigned to the merchant that the authorization belongs to.

sale_id

String

The Pay Theory unique identifier assigned to the sale that the authorization belongs to. Sales can be used to tie together multiple auths and captures.

wallet_type

WalletType

The type of digital wallet being used. Can be one of: APPLE_PAY, GOOGLE_PAY, CLICK_TO_PAY, SAMSUNG_PAY, VISA_STAGED

Values

APPLE_PAYCLICK_TO_PAYGOOGLE_PAYPAZESAMSUNG_PAYVISA_STAGED

digital_wallet_payloadRequired

String

The encrypted payload from the PayTheory SDK containing payment information.

amount

Int

The amount of the authorization in cents.

fee

Int

The amount of the service fee in cents. Required if fee_mode is SERVICE_FEE.

billing_address

BillingAddressInput

The billing address information for the authorization.

payor_id

String

The Pay Theory unique identifier for the payor making the payment.

payor

PayorInput

The payor information if a new payor needs to be created.

invoice_id

String

The Pay Theory unique identifier assigned to the invoice that the authorization belongs to.

account_code

String

Custom defined value passed in as the account code for the authorization.

reference

String

Custom defined value passed in as the reference for the authorization.

metadata

AWSJSON

Any additional data that should be stored with the authorization.

health_expense_type

HealthExpenseType

The health expense type for the authorization. Can be one of: CLINICAL, COPAY, DENTAL, HEALTHCARE, RX, TRANSIT, VISION

Values

CLINICALCOPAYDENTALHEALTHCARERXTRANSITVISION

additional_purchase_data

AdditionalPurchaseDataInput

Additional purchase data for Level 3 processing requirements.

Response

Authorization

account_code

String| null

Custom defined value passed in as the account code for the authorization.

additional_purchase_data

AdditionalPurchaseData| null

Additional purchase data for Level 3 processing requirements.

amount

Int

The amount of the authorization in cents.

authorization_date

AWSDateTime

The date and time the authorization was created.

authorization_id

String

The Pay Theory unique identifier assigned to the authorization.

avs_status

AvsStatus| null

The AVS status of the authorization.

Values

NO_MATCHPOSTAL_CODE_AND_STREET_MATCHPOSTAL_CODE_MATCHSTREET_MATCHUNKNOWN

captured_amount

Int| null

The amount of the authorization that has been captured in cents.

currency

String

The currency of the authorization. Currently only USD is supported.

device_id

String| null

-

expiration_date

AWSDateTime| null

The date and time the authorization will expire.

failure_reasons

[String]| null

Array of failure reasons for the authorization. If the authorization is successful, this will be null.

fee_mode

FeeMode

The fee mode for the authorization. It can be one of the following: SERVICE_FEE, MERCHANT_FEE

Values

CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE

fees

Int

The amount of fees for the authorization in cents.

invoice

Invoice| null

The invoice object for the invoice that the authorization belongs to. More information on the invoice object can be found here.

merchant_uid

String

The Pay Theory unique identifier assigned to the merchant to batch for.

metadata

AWSJSON| null

Any additional data that was stored with the authorization.

payment_method

PaymentMethodToken

The payment method token object for the payment method that the authorization belongs to. More information on the payment method token object can be found here.

processor

String| null

-

reference

String| null

Custom defined value passed in as the reference for the authorization.

sale_id

String| null

The Pay Theory unique identifier assigned to the sale that the authorization belongs to. Sales can be used to tie together multiple auths and captures.

status

AuthorizationStatus

The status of the authorization. It can be one of the following: CANCELLED, FAILED, SUCCEEDED

Values

CANCELEDFAILEDSUCCEEDED

timezone

String| null

The timezone of the authorization.

transaction_id

String| null

The Pay Theory unique identifier assigned to the transaction that the authorization belongs to.

updated_row_at

AWSDateTime| null

The date and time the authorization was last updated.

Examples

Invalid wallet payload

Returns an error when digital_wallet_payload is not a token from the Pay Theory SDK.

ERROR 200

GRAPHQL

mutation CreateWalletAuthorization(
  $merchant_uid: String!
  $digital_wallet_payload: String!
  $wallet_type: WalletType
  $amount: Int
) {
  createWalletAuthorization(
    merchant_uid: $merchant_uid
    digital_wallet_payload: $digital_wallet_payload
    wallet_type: $wallet_type
    amount: $amount
  ) {
    authorization_id
    amount
    status
  }
}