Skip to main content

Fields

accountHolder : String! required
accountType : String
bankCode : String
cardExpiryMonth : Int
cardExpiryYear : Int
cardNumber : String! required
cardPaymentNetwork : String
cardType : String
iban : String! required
id : ID! required
instructionType : String

Payment instruction type.

lastFourDigitsOfAccountNumber : String

The last four digits of the account number.

Deprecation
The 'lastFourDigitsOfAccountNumber' field is deprecated.

Use 'maskedAccountIdentifier' for a masked reference to the instruction.

- Marked as deprecated on 2021-12-23.
- Scheduled for removal on or after 2024-01-01.
maskedAccountIdentifier : String

A masked reference to a recurring payment method.

maskedIban : String

A masked version of the IBAN.

The owners of the financial account this instruction represents.

sortCode : String! required
status : String! required
supplementaryLedger : SupplementaryLedgerType
validFrom : DateTime! required
vendor : String! required
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.

Example

{ "accountHolder": "consumer-ten-crime-source-everybody", "accountType": "director-central-significant-again-magazine", "bankCode": "contain-situation-bar-down-receive", "cardExpiryMonth": 28, "cardExpiryYear": 12, "cardNumber": "kid-pretty-own-close-reality", "cardPaymentNetwork": "structure-religious-upon-design-threat", "cardType": "need-top-table-matter-glass", "iban": "major-memory-professor-value-prove", "id": "51817167", "instructionType": "painting-three-of-lose-indeed", "maskedAccountIdentifier": "19595325", "maskedIban": "energy-yard-position-follow-wrong", "owners": [PaymentInstructionOwnerType], "sortCode": "training-difficult-energy-stage-thank", "status": "weight-indeed-activity-class-fact", "supplementaryLedger": SupplementaryLedgerType, "validFrom": "1976-07-21T16:52:12.762499+00:00", "vendor": "issue-party-everything-should-rest" }