Archive a GbBankAccount object v2

Response attributes

• idstring

  The ID of the GBBankAccount object.

• objectstring, value is "v2.core.vault.gb_bank_account"

  String representing the object’s type. Objects of the same type share the same value of the object field.

• archivedboolean

  Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.

• bank_account_typeenum

  The type of the bank account (checking or savings).

  Possible enum values

  checking Checking account.

  savings Savings account.

• bank_namestring

  The name of the bank.

• confirmation_of_payeeobject

  Information around the status of Confirmation of Payee matching done on this bank account. Confirmation of Payee is a name matching service that must be done before making OutboundPayments in the UK.

  Hide child attributes

  • confirmation_of_payee.resultobject

    The result of the Confirmation of Payee check, once the check has been initiated. Closed enum.

    Hide child attributes

    • confirmation_of_payee.result.createdtimestamp

      When the CoP result was created.

    • confirmation_of_payee.result.match_resultenum

      Whether or not the information of the bank account matches what you have provided. Closed enum.

      Possible enum values

      match The information matched what was provided by the CoP service.

      mismatch The name or business type does not match what was provided. Funds can still be sent to this account by acknowledging this result, but caution is advised.

      partial_match The name or business type is similar to what was provided, but doesn’t completely match. Funds can still be sent to this account by acknowledging this result, but caution is advised.

      unavailable The service is down or other technical issues that prevent Confirmation of Payee matching from happening. This is a rare occurence. Funds can still be sent to this account by acknowledging this result, but caution is advised.

    • confirmation_of_payee.result.matchedobject

      The fields that CoP service matched against. Only has value if MATCH or PARTIAL_MATCH, empty otherwise.

      Hide child attributes

      • confirmation_of_payee.result.matched.business_typenullable enum

        The business type given by the bank for this account, in case of a MATCH or PARTIAL_MATCH. Closed enum.

        Possible enum values

        business Business Account.

        personal Personal Account.

      • confirmation_of_payee.result.matched.namenullable string

        The name given by the bank for this account, in case of a MATCH or PARTIAL_MATCH.

    • confirmation_of_payee.result.messagestring

      Human-readable message describing the match result.

    • confirmation_of_payee.result.providedobject

      The fields that are matched against what the network has on file.

      Hide child attributes

      • confirmation_of_payee.result.provided.business_typeenum

        The provided or Legal Entity business type to match against the CoP service. Closed enum.

        Possible enum values

        business Business Account.

        personal Personal Account.

      • confirmation_of_payee.result.provided.namestring

        The provided or Legal Entity name to match against the CoP service.

  • confirmation_of_payee.statusenum

    The current state of Confirmation of Payee on this bank account. Closed enum.

    Possible enum values

    awaiting_acknowledgement The check resulted in a non-match, partial match, or the service was unavailable. Explicit acknowledgement is required to make payments to this account.

    confirmed Either the account matches what was provided or there was explicit acknowledgement of the status. OutboundPayments can be made to the bank account.

    uninitiated No confirmation of payee check has happened on this account. Use InitiateConfirmationOfPayee to check the user’s information against bank records before making OutboundPayments.

• createdtimestamp

  Creation time.

• last4string

  The last 4 digits of the account number or IBAN.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• sort_codestring

  The Sort Code of the bank account.