Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
  "verification_code": 4365
}

...

POST /client-id/{client_id}/

...

customers/driverslicense

Code Block
breakoutModewide
https://{posapi_url}/flexiti/pos-api/v2.5/client-id/{client_id}/accountscustomers/12345/closedriverslicense

This endpoint allows the closure of a QC accountdecoding of PDF417 scanned driver license information.

Request Parameters:

Type

Parameter

Required

Details

HEADER

authorization

Yes

  • ASCII string (1000)

  • This is the word “Bearer” with a space and then the access_token given in oauth/token API response

  • Default value: Bearer {insert_bearer_token_from_oauth_here/token_api}

HEADER

x-reference-id

Yes

  • ASCII string (32)

  • GUID

  • Unique identifier for the flow for traceability purposes

PATH

client_id

Yes

  • ASCII string (100)

  • This is the Client ID given in the Developer User Account section

PATH

BODY

account_number

code

Yes

  • number (14)

  • The Account Number of the Customer to be closed

Success Response:

200 - Success

...

  • ASCII string

  • PDF417 code with driver licence information

Example Request:

Code Block
languagejson
{
    "code": "@\n\u001e\rANSI\n604428040101 DL00310219DLDCAunavI\nDCBNONE\nDCDNONE\nDBA20200515\nDCSNUMBER1\nDACENSTREAM \nDAD\nDBD20140516\nDBB19740515\nDBCZ\nDAYBLU\nDAU163 cm\nDAG55 UNIVERSITY AVE\nDAITORONTO\nDAJON\nDAKM5J 2H7\nDAQD61014070660905\nDCFPEJK368N4\nDCGCAN\nDDEU\nDDFU\nDDGU\r"
}

Success Response:

Code Block
languagejson
{
    "first_name": "John",
    "middle_name": "Garry",
    "last_name": "Smith",
    "dob": "1974-05-15",
    "address_1": "123 ANY STREET",
    "city": "TORONTO",
    "province": "ON",
    "postal_code": "M1M 1M1",
    "govid_type": "CADL",
    "govid_issuedby": "ON",
    "govid_number": "D61014070123456",
    "govid_expiry": "2021-05-15"
}

...

POST /client-id/{client_id}/accounts/{account_number}/calculate-interest

...

Type

Parameter

Required

Details

HEADER

authorization

Yes

  • ASCII string (1000)

  • This is the word “Bearer” with a space and then the access_token given in oauth/token API response

  • Default value: Bearer {insert_bearer_token_from_oauth_here/token_api}

HEADER

x-reference-id

Yes

  • ASCII string (32)

  • GUID

  • Unique identifier for the flow for traceability purposes

PATH

client_id

Yes

  • ASCII string (100)

  • This is the Client ID given in the Developer User Account section

PATH

account_number

Yes

  • number (14)

  • The Account Number of the Primary Account Holder

  • his is not the FlexitiCard number (VCC)

QUERY

lang


  • ASCII string (5)

  • Customer Preferred language

  • Available values: (en=English) or (fr=French)

  • Default value: en

BODY

amount

  • number (18,2)

  • Amount of the transaction to calculate interest on

Example Request:

Code Block
{
    "amount": 234.45
}

...