createOneTimePayment

MUTATION

Deprecated: Use createTransaction instead.

This call was deprecated in favor of the createTransaction mutation. The createTransaction mutation returns a more detailed response than this call.

Arguments

merchant_uidRequired

String

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

amountRequired

Int

The amount of the transaction. If the FeeMode is SERVICE_FEE, this is the amount of the transaction before fees.

payment_method_id

String

The Pay Theory unique identifier for the payment method the transaction will be charged to.

payment_method

PaymentMethodInput

The payment method to be used for the transaction. This is required if you are not passing in a payment_method_id.

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.

fee

Int

The amount of the fee that will be charged to the payor for the transaction if the FeeMode is SERVICE_FEE.

fee_mode

FeeMode

The fee mode on the transaction. SERVICE_FEE charges the fees to the payor. MERCHANT_FEE charges the fees to the merchant. Options are:

Values

CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE

payment_parameters_name

String

-

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 health expense type.

Values

CLINICALCOPAYDENTALHEALTHCARERXTRANSITVISION

additional_purchase_data

AdditionalPurchaseDataInput

The additional purchase data.

Response

OneTimePayment

amount

Int| null

Amount in minor units (for example cents).

card_brand

String| null

The card brand.

created_at

AWSDateTime| null

The date and time this was created.

currency

String| null

Currency code.

failure_reason

String| null

The failure reason.

last_four

String| null

The last four.

service_fee

Int| null

The service fee.

status

TransactionStatus| null

Status value.

Values

CANCELEDFAILEDPARTIALLY_REFUNDEDPENDINGREFUNDEDRETURNEDSETTLEDSUCCEEDEDVOIDED

transaction_id

String| null

Pay Theory unique identifier for the transaction.

Examples

Missing payment method

Returns an error when neither payment_method nor payment_method_id is supplied.

ERROR 200

GRAPHQL

mutation CreateOneTimePayment(
  $merchant_uid: String!
  $amount: Int!
  $fee_mode: FeeMode
) {
  createOneTimePayment(
    merchant_uid: $merchant_uid
    amount: $amount
    fee_mode: $fee_mode
  ) {
    transaction_id
    status
    amount
    service_fee
    card_brand
    last_four
    currency
    failure_reason
    created_at
  }
}