v1

latestOpenAPI 3.1.02026-07-24136043.5 KB

Create a new OBV Flow

post/obv

Request body

countryCode'US' | 'CA' required

Country. Must be 'CA'.

accountTokenstring

Account token for reauthorization

Example request

{
  "merchant": {
    "merchantId": "Paramount",
    "merchantUserId": "user"
  },
  "transaction": {
    "transactionType": "DEBIT",
    "transactionAmount": 19384,
    "transactionRegion": "QC",
    "returnUrl": "http://localhost:3000/return-url"
  },
  "consumer": {
    "firstName": "Alberta",
    "lastName": "Charleson",
    "dob": "1971-01-01",
    "postalCode": "H3B-5E8",
    "emailAddress": "frodo@bagend.com",
    "emailAddressVerifiedTime": "2021-06-04T16:39:57-08:00",
    "phoneNumberVerifiedTime": "2021-06-04T16:39:57-08:00",
    "originatorIp": "174.26.150.77"
  },
  "accountToken": "167371ae-4e59-433c-bc28-641140408931"
}

Response

The consumer should fulfill verification with the returned URL

consumerUrlstring

The URL that the Consumer should be directed to in order to fulfil the verification.