borderless Docs

borderless Docs

  • Account Setup
  • Account Services
  • Verification
  • Payments
  • Refunds
  • Developer Tools

›Mutations

Account Setup

    Queries

    • accountIdentificationTypes
    • accountSetupSession
    • allCountries
    • businessTypes
    • isValidBusinessTaxId
    • isValidPersonalTaxId
    • isValidSlug
    • jobTitles
    • naics
    • supportedCountries
    • zoneCodes

    Mutations

    • addAccountToPerson
    • addCompanyOfficerToAccount
    • createAccountSetupSession
    • createLoginPersonAndAccount
    • deactivateAccount
    • resendEmailVerification
    • submitAccountSetupSession
    • submitCompanyOfficers
    • updateAccountSetupSession

Account Services

    Queries

    • account
    • accounts
    • bankAccounts
    • companyOfficers
    • person
    • publicAccountBySlug

    Mutations

    • addBankAccount
    • changePassword
    • changePreferredBankAccount
    • login
    • logout
    • requestPasswordReset
    • sendInvitationEmail
    • sendInvitedRegisterEmail
    • switchAccounts
    • updateAccount
    • updatePerson

Verification

    Mutations

    • addOnfidoDocumentToPerson
    • embedOnfido

Payments

    Queries

    • contacts
    • paymentActivity
    • paymentActivityById
    • paymentRequestById
    • paymentSession
    • requestedPayments
    • tradeConfirmationForPayment

    Mutations

    • clearPaymentSession
    • createPaymentForRequestSession
    • createPaymentSession
    • declinePaymentRequest
    • generatePayMeRequest
    • requestPayment
    • resendPaymentRequest
    • submitPaymentSession
    • updatePaymentSession
    • updateQuote

Refunds

    Queries

    • refundSession

    Mutations

    • clearRefundSession
    • createRefundSession
    • submitRefundSession
    • updateRefundSession

Developer Tools

    Queries

    • accountWebhooks
    • embedVerificationService

    Mutations

    • createWebhook
    • healthCheck
    • testWebhook

updateAccountSetupSession

Overview

This mutation updates the current account setup session with person, account, bank account, or ID upload details.

Special Considerations

  • Must be signed into an account and created an account setup session to call this mutation.

Inputs

UpdateAccountSetupSessionArgs

addedBankAccount (optional): AddBankAccountInput {
  yodleeBankAccountId (optional): string,
  manualBankData (optional): ManualBankDataInput {
    accountNumber (optional): string,
    routingNumber (optional): string,
    bankName (optional): string,
    country (optional): Country,
    currency (optional): Currency,
    accountType (optional): string
  }
}
  personSetup (optional): PersonSetupInput {
    firstName (required): string,
    middleName (optional): string,
    lastName (optional): string,
    phone (optional): string,
    phoneCountryCode (optional): Country,
    dateOfBirth (optional): DateTime,
    personalTaxId (optional): string,
    citizenship (optional): string,
  }
  accountSetup (optional): AccountSetupInput {
    addressLine1 (optional): string,
    addressLine2 (optional): string,
    city (optional): string,
    zoneCode (optional): string,
    postalCode (optional): string,
    identificationType (optional): string,
    name (optional): string,
    displayName (optional): string,
    slug (optional): string,
    businessType (optional): string,
    businessTaxId (optional): string,
    industry (optional): string,
    estimatedMonthlyVolume (optional): float,
    estimatedMonthlyTransactions (optional): int,
    businessSize (optional): int,
    jobTitle (optional): string,
    zoneCodeOfIncorporation (optional): string,
  }
  idUploaded (optional): UploadIdInput {
    applicantId (required): string
}

Returns

Promise<SuccessResult>

A promise containing a success message.

Example

Running this mutation:

mutation {
  updateAccountSetupSession (data: {
    accountSetup: {
      addressLine1: "Testing"
      addressLine2: "Subject"
      city: "Brisbane"
    }
  })
    {
    message
  }
}

Gives us:

{
  "data": {
    "updateAccountSetupSession": {
        "message": "Account setup session successfully updated."
    }
  }
}

Common Errors

When running this mutation some of the common errors encountered include:

  • You cannot update your personal information (I-4401).

    • There was an error in updating your account information
  • This is not a valid date. Must strictly match format: YYYY-MM-DD (I-4303).

    • Please enter a valid date in the specified format for the date of birth field.
  • This is not a valid handle. (I-4304)

    • The slug given is not valid. Must meet requirements (unique to borderless and at least 3 characters and no longer than 24 characters in length, containing only letters and numbers)
  • A user with this PayMe Handle already exists. (I 4309)

    • This PayMe handle (slug) is already taken. Please choose a different handle.
← submitCompanyOfficersNext →
  • Overview
  • Special Considerations
  • Inputs
    • UpdateAccountSetupSessionArgs
  • Returns
    • Promise<SuccessResult>
  • Example
  • Common Errors
borderless Docs
Docs
Account SetupAccount ServicesVerificationPaymentsRefundsDeveloper Tools
More
LoginBlogGitLabLinkedInInstagramTwitter
Facebook Open Source
Copyright © 2022 borderless