Get bank details for a client that possess an OBV Token

get/obv/{obvToken}/bank-details

Path parameters

obvTokenstring required

A Paramount OBV token that must be provided on requests that seek to perform a verification of an existing bank account.

Query parameters

merchantIdstring required

Merchant's assigned Paramount Commerce ID

merchantUserIdstring required

Merchant User ID

Response

Get Bank Details Response

obvTokenstring

A Paramount OBV token that must be provided on requests that seek to perform a verification of an existing bank account.

firstNamestring

User's first name

lastNamestring

User's last name

state'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FM' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MH' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PW' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT'

User's home address state. Use the standard 2-letter state abbreviation as defined by USPS.

country'US' | 'CA'

Country. Must be 'CA'.

zipstring

User's home address zip code (NNNNN or ANA-NAN or ANA NAN or ANANAN (A = Alphabet, N = Numeric))

Example response

{
  "zip": "H3B-5E8"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.