defaultPaymentInstruction

Get the default payment instruction for the account's main ledger.

Deprecation

The 'defaultPaymentInstruction' field is deprecated.

Please use 'usablePaymentInstructions' on the Ledger type to get all usable instructions, or 'paymentPreferenceAtTime' on the Ledger type to get a specific one. Both require explicitly requesting a ledger.

- Marked as deprecated on 2026-01-28.
- Scheduled for removal on or after 2027-01-28.

Arguments

accountNumber : String!


            required

The account number.

instructionType : PaymentType

Provide an option to get either a CARD or DIRECT_DEBIT instruction.

Returns

PaymentInstructionType

Payment Instructions

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query DefaultPaymentInstruction(
  $accountNumber: String!,
  $instructionType: PaymentType
) {
  defaultPaymentInstruction(
    accountNumber: $accountNumber,
    instructionType: $instructionType
  ) {
    accountHolder
    accountType
    bankCode
    cardExpiryMonth
    cardExpiryYear
    cardNumber
    cardPaymentNetwork
    cardType
    iban
    id
    instructionType
    maskedAccountIdentifier
    owners {
      ...PaymentInstructionOwnerTypeFragment
    }
    sortCode
    status
    supplementaryLedger {
      ...SupplementaryLedgerTypeFragment
    }
    validFrom
    vendor
  }
}

{
  "accountNumber": "A-83B3ED60",
  "instructionType": "BPAY"
}

{
  "data": {
    "defaultPaymentInstruction": {
      "accountHolder": "star-leg-oil-deep-resource",
      "accountType": "form-order-travel-yes-animal",
      "bankCode": "something-tax-floor-himself-oil",
      "cardExpiryMonth": 26,
      "cardExpiryYear": 52,
      "cardNumber": "civil-station-position-soldier-air",
      "cardPaymentNetwork": "hold-then-my-north-effect",
      "cardType": "bag-present-field-address-Mr",
      "iban": "modern-can-value-sit-it",
      "id": "35516257",
      "instructionType": "agree-point-seat-rather-suffer",
      "maskedAccountIdentifier": "98988526",
      "owners": [PaymentInstructionOwnerType],
      "sortCode": "language-form-environmental-employee-player",
      "status": "early-onto-small-compare-investment",
      "supplementaryLedger": SupplementaryLedgerType,
      "validFrom": "2009-07-01T07:58:03.074293+00:00",
      "vendor": "point-wide-toward-natural-Mrs"
    }
  }
}