Version: Lab (preview)

createWalletTransaction

MUTATION

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

Arguments

app_id

String

The Pay Theory unique identifier for the application.

merchant_uidRequired

String

The Pay Theory unique identifier for the merchant the transaction is for.

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 transaction 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 transaction.

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.

recurring_id

String

The Pay Theory unique identifier for the recurring payment the transaction is for.

invoice_id

String

The Pay Theory unique identifier for the invoice the transaction is for.

account_code

String

Customer defined account code for the transaction.

reference

String

Customer defined reference for the transaction.

send_receipt

Boolean

If the receipt should be sent to the payor. Defaults to false. It is sent to the email address on file with the payment method.

receipt_description

String

The description of the transaction that will be displayed on the receipt.

metadata

AWSJSON

Custom defined JSON object to be stored with the transaction.

health_expense_type

HealthExpenseType

The type of health expense for the transaction. 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.

split

[SplitInput]

An array of split objects to distribute the transaction amount to different accounts. The sum of all split amounts must equal the transaction amount.

Response

Transaction

account_code

String| null

Customer defined account code for the transaction.

ach_return_details

AchReturnDetails| null

The details of the ACH return if any.

additional_purchase_data

AdditionalPurchaseData| null

The additional purchase data.

authorization_id

String| null

The authorization id for the transaction.

avs_status

AvsStatus| null

The AVS status for the transaction.

Values

NO_MATCHPOSTAL_CODE_AND_STREET_MATCHPOSTAL_CODE_MATCHSTREET_MATCHUNKNOWN

currency

String| null

The type of currency for the transaction.

device_id

String| null

dispute_status

DisputeStatus| null

The status of the dispute if any.

Values

INQUIRYLOSTPENDINGWON

failure_reasons

[String]| null

List of strings, if any, detailing the reason a transaction failed. See Failure Codes for a complete list of failure codes and descriptions.

fee_mode

FeeMode| null

The fee mode on the transaction.

Values

CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE

fees

Int| null

The amount of the fees charged for the transaction.

flag_for_review

TransactionReviewStatus| null

A status indiciator for any transactions that are in review. When a transaction is in review the funds will not settle to the merchant until resolved.

Values

EXCEEDS_AUTHEXCEEDS_FEE_LIMITEXCEEDS_THRESHOLDPOTENTIAL_DUPLICATE

gross_amount

Int| null

The total amount of the transaction.

invoice

Invoice| null

The invoice object for the transaction if any.

is_settled

Boolean| null

Whether the transaction has been settled.

merchant

ListMerchant| null

The merchant object of the merchant the transaction belongs to.

merchant_uid

String| null

The Pay Theory unique identifier for the merchant the transaction is for.

metadata

AWSJSON| null

Custom defined JSON object to be stored with the transaction.

net_amount

Int| null

The total amount of the transaction after fees.

parent_id

String| null

The Pay Theory unique identifier for the parent transaction if any.

payment_method

PaymentMethodToken| null

The payment method used to make the transaction.

processor

String| null

recurring

RecurringPayment| null

The recurring payment that the transaction belongs to if any.

reference

String| null

Customer defined reference for the transaction.

refund_reason

RefundReason| null

The reason for the refund if any.

refund_voidable

Boolean| null

Whether the refund can be voided.

refunded_amount

Int| null

The amount of the transaction that has been refunded if any.

sale_id

String| null

The sale id for the transaction if any.

settlement_batch

Int| null

The unique settlement batch number the transaction belongs to if settled.

splits

[Split]| null

An array of split objects associated with this transaction, if any.

status

TransactionStatus| null

The status of the transaction.

Values

CANCELEDFAILEDPARTIALLY_REFUNDEDPENDINGREFUNDEDRETURNEDSETTLEDSUCCEEDEDVOIDED

timezone

String| null

The timezone the transaction was made in.

transaction_date

AWSDateTime| null

The date the transaction was made.

transaction_id

String| null

The Pay Theory unique identifier for the transaction.

transaction_type

TransactionType| null

The type of transfer that was made.

Values

ACH_RETURNDEBITFAILUREREVERSAL

updated_row_at

AWSDateTime| null

The date and time the transaction was last updated.

Examples

Invalid wallet payload

Returns an error when digital_wallet_payload is not a valid token.

ERROR 200

GRAPHQL

mutation CreateWalletTransaction(
  $merchant_uid: String!
  $digital_wallet_payload: String!
  $wallet_type: WalletType
  $amount: Int
) {
  createWalletTransaction(
    merchant_uid: $merchant_uid
    digital_wallet_payload: $digital_wallet_payload
    wallet_type: $wallet_type
    amount: $amount
  ) {
    transaction_id
    gross_amount
    status
  }
}