---
title: "Create a new OBV Flow"
method: POST
path: "/obv"
---

# Create a new OBV Flow

`POST /obv`

## Request body

- InitiateOBVRequest
  - `countryCode` 'US' | 'CA', required — Country. Must be 'CA'.
  - `merchant` Merchant, required
    - `merchantId` string, required — Merchant's assigned Paramount Commerce ID
    - `merchantSubId` string, required — "Merchant Sub ID. This parameter is used to separate reporting and notifications by Merchants who process transactions for multiple websites or need to separate their traffic for other reasons."
    - `merchantUserId` string, required — Merchant's user ID
    - `merchantTransactionId` string, required
  - `transaction` Transaction, required
    - `transactionType` 'DEBIT' | 'CREDIT' | 'VERIFY', required — The type of transaction. Must be either DEBIT or CREDIT.
    - `transactionAmount` integer, required — Integer representing transaction amount in cents.
    - `currencyCode` 'USD' | 'CAD', required — Currency of the transaction. Only CAD is expected.
    - `transactionRegion` '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' — "The state where the payment transaction amount will be used. For example, if a Consumer in Texas makes a payment transaction that will be used by the Consumer when they are in New Jersey, the txn_state is NJ. Use the standard 2-letter state abbreviation as defined by USPS." type: string
    - `returnUrl` string, required — The URL where the Consumer’s browser is redirected at the end of the payment process. Merchants can include URL query string parameters, which are passed back to the Merchant system in the payment redirect response. The URL query string must be URL-encoded.
  - `consumer` Consumer, required
    - `firstName` string, required — User's first name
    - `lastName` string, required — User's last name
    - `dob` string, yyyy-mm-dd, required — User's date of birth. Must be in ISO format: YYYY-MM-DD
    - `region` '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', required — User's home address state. Use the standard 2-letter state abbreviation as defined by USPS.
    - `postalCode` string, required — User's home address postal code (NNNNN or ANA-NAN or ANA NAN or ANANAN (A = Alphabet, N = Numeric))
    - `emailAddress` string, email — User's email address
    - `emailAddressVerifiedTime` string — ISO 8601 full-time formatted timestamp of when the merchant last verified the user's ownership of the email address via an acceptable OTP method.
    - `phoneNumber` string, required — User's phone number
    - `phoneNumberVerifiedTime` string — ISO 8601 full-time formatted timestamp of when the merchant last verified the user's ownership of the phone number via an acceptable OTP method.
    - `originatorIp` string, required — IP address the consumer is currently on
  - `accountToken` string — Account token for reauthorization

## Response `201`

The consumer should fulfill verification with the returned URL

- InitiateOBVResponse
  - `consumerUrl` string — The URL that the Consumer should be directed to in order to fulfil the verification.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.dev/paramountcommerce/apis/interac-api.md) · [All operations](https://skmtc.dev/paramountcommerce/apis/interac-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/paramountcommerce/interac-api/revisions/18be16246225/schema)