Choose a version:

PaymentInstrument

union

Requires read_payment_mandate access scope.

All possible instrument outputs for Payment Mandates.

Anchor to Possible typesPossible types

•OBJECT

Represents a bank account payment instrument.

Anchor to accountHolderTypeaccountHolderType •BankAccountHolderType! non-null: The type of account holder.
Anchor to accountTypeaccountType •BankAccountType! non-null: The type of bank account.
Anchor to bankNamebankName •String! non-null: The name of the bank.
Anchor to billingAddressbillingAddress •CustomerPaymentInstrumentBillingAddress: The billing address associated with the bank account.
Anchor to lastDigitslastDigits •String! non-null: The last four digits of the account number.

•OBJECT

Represents a credit card payment instrument.

Anchor to billingAddressbillingAddress •CustomerCreditCardBillingAddress: The billing address of the card.
Anchor to brandbrand •String! non-null: The brand for the card.
Anchor to expiredexpired •Boolean! non-null: Whether the card has been expired.
Anchor to expiryMonthexpiryMonth •Int! non-null: The expiry month of the card.
Anchor to expiryYearexpiryYear •Int! non-null: The expiry year of the card.
Anchor to lastDigitslastDigits •String! non-null: The last four digits for the card.
Anchor to namename •String! non-null: The name of the card holder.

•OBJECT

Represents a paypal billing agreement payment instrument.

Anchor to inactiveinactive •Boolean! non-null: Whether the paypal billing agreement is inactive.
Anchor to namename •String! non-null: The paypal account name.
Anchor to paypalAccountEmailpaypalAccountEmail •String! non-null: The paypal account email address.

Was this section helpful?

Anchor to PaymentMandate.paymentInstrument PaymentMandate.paymentInstrument •OBJECT: A payment instrument and the permission the owner of the instrument gives to the merchant to debit it.

Was this section helpful?