createPaymentMethod

MUTATION

This mutation will create a payment method token for a payor. The payment method token can be used to create a payment method for a merchant.

Arguments

payment_methodRequired

PaymentMethodInput

The payment method input object. Refer to the PaymentMethodInput docs for more info.

merchant_uidRequired

String

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

skip_validation

Boolean

A boolean flag indicating whether to skip the validation of the payment method. Defaults to false if not passed in.

Response

PaymentMethodToken

address_line1

String| null

The first line of the billing address.

address_line2

String| null

The second line of the billing address.

bank_account_type

BankAccountType| null

The type of bank account.

Values

BUSINESS_CHECKINGBUSINESS_SAVINGSPERSONAL_CHECKINGPERSONAL_SAVINGS

bank_code

String| null

The bank code of the bank account if payment_type is ACH.

barcode_id

String| null

The barcode id of the payment method token if payment_type is CASH.

card_brand

String| null

The brand of the card if payment_type is CARD.

card_type

CardType| null

The type of card if payment_type is CARD.

Values

BUSINESS_CREDITBUSINESS_DEBITCREDIT_CARDDEBIT_CARDPREPAID_CARD

city

String| null

The city of the billing address.

country

String| null

The country of the billing address.

cvv_status

CvvStatus| null

The CVV status.

Values

MATCHNO_MATCHUNKNOWN

exp_date

String| null

The expiration date of the card if payment_type is CARD. Format: MMYY

full_name

String| null

The name on card or bank account.

is_active

Boolean| null

Indicator for if payment method is active. If false the payment method cannot be used to process new transactions.

issuing_country_code

String| null

The issuing country code of the country that issued the card or that the bank account was opened in.

last_four

String| null

The last four digits of the card or bank account number.

merchant_uid

String| null

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

metadata

AWSJSON| null

Any additional data that was stored with the payment method token.

payment_method_id

String| null

The unique payment method id.

payment_type

PaymentType| null

The type of payment method. It can be one of the following: CARD, ACH

Values

ACHCARDCASH

payor

Payor| null

The payor object. Refer to the Payor docs for more info.

postal_code

String| null

The postal code of the billing address.

region

String| null

The region of the billing address.

wallet_type

WalletType| null

The type of wallet that the payment method token is stored in.

Values

APPLE_PAYCLICK_TO_PAYGOOGLE_PAYPAZESAMSUNG_PAYVISA_STAGED

Examples

Save a card

Saves a card as a payment method for later transactions. The response formats exp_date as MMYY (1230 means December 2030). An is_active value of true means the card can be used again.

SUCCESS 200

GRAPHQL

mutation CreatePaymentMethod(
  $merchant_uid: String!
  $payment_method: PaymentMethodInput!
) {
  createPaymentMethod(
    merchant_uid: $merchant_uid
    payment_method: $payment_method
  ) {
    payment_method_id
    merchant_uid
    payment_type
    last_four
    card_brand
    exp_date
    full_name
    is_active
  }
}