v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Account Verification Endpoints

account-verification

This endpoint is used to fetch the details of a micro deposit transaction.

get/account-verification

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

VerificationRequestIDinteger required

Value of the Account Verification Request ID

RequestStatusstring

The account verification request status. Can be 'active' or 'expired'

VerificationStatusstring

The vefification status of the account. Can be 'unverified', 'verified' or 'failed'

VerificationTypestring

The verification type. Can be 'bank' or 'interac'

SearchTextstring

A text string to search for in the email addresses used for Account Verification process.

StartDateTimestring date-time

Return micro deposit transactions that occurred on or after this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.

EndDateTimestring date-time

Return micro deposit transactions that occurred on or before this date/time. Can be specified in either YYYY-MM-DD HH:MM:SS or YYYY-MM-DD format.

Limitinteger

Limit the number of records that are returned.

Offsetinteger

Use this parameter to set the starting point in the dataset.

Timezonestring

Use this parameter to convert the time to the specified timezone. If no timezone is specified, the default is UTC.

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

ClientAccountIDstring

The client account ID.

VerificationRequestIDinteger

Your updated Account Verification Request ID

AccountHolderNamestring

Account holder name associated with the Account Verification Request ID

VerificationTypestring

The verification type. Can be 'bank' or 'interac'

Amountinteger

Amount associated with the Account Verification Request ID

PaymentRailstring

The payment rail used for the verification transaction

VerificationAttemptsinteger

Verification attempt count associated with the Account Verification Request ID

Linkstring

Link associated with the Account Verification Request ID

Notesstring

Note associated with the Account Verification Request ID

LastModifiedstring date-time

Last modified date/time associated with the Account Verification Request ID

Example response

{
  "ClientAccountID": "johndoe",
  "AccountHolderName": "John Smith",
  "VerificationType": "bank",
  "Details": {
    "Credit": {
      "FirstName": "John",
      "LastName": "Smith",
      "CreditCardToken": "a022ff77a55e6d00bf271a2b36c65a26600a1a25",
      "CreditCardBrand": "mastercard",
      "CreditCardNumber": "***********4567"
    },
    "Debit": {
      "FirstName": "John",
      "LastName": "Smith",
      "DebitCardToken": "a022ff77a55e6d00bf271a2b36c65a26600a1a25",
      "DebitCardBrand": "mastercard",
      "DebitCardNumber": "***********4567"
    },
    "Bank": {
      "AccountNumber": "123456789",
      "Currency": "USD"
    },
    "EmailAddress": {
      "AccountHolderName": "John Smith",
      "EmailAddress": "john.smith@example.com"
    }
  },
  "PaymentRail": "ACH Withdrawal",
  "Status": {
    "Transaction": {
      "Credit": "in progress",
      "Debit": "in progress"
    },
    "Verification": "unverified",
    "Request": "unverified"
  },
  "Link": "https://request-dev.vopay.com/?AccountVerificationToken=1sqzvv",
  "Notes": "This is a note",
  "LastModified": "2019-01-01 00:00:00",
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}