These are all of the Endpoints required to identify or interact with Customers.
...
Type | Parameter | Details |
---|
BODY | customer_id | ASCII string (20) The Customer ID of the account This is not the Account Number The customer ID may return a '-' delimited value for an authorized business customer. in the format of: “[master-cust-id]-[authorized-user-id]”
|
BODY | account_status | ASCII string (1) “N” - Normal (only status that allows Authorizations/Purchases) “A” - Auth Prohibited (Authorizations/Purchases are prohibited due to lack of payment, this status can be reverted automatically by the system) “F” - Frozen (Frozen accounts can NOT make Authorizations/Purchases, this status can only be reverted manually by Operations) “Z” - Charged Off (When accounts do not pay for 6 or more months, the account is written off the Portfolio) “C” - Closed (no longer in use, this represents accounts that are closed and can NOT be brought back to life, there are some old accounts with this status)
|
BODY | account_status_reason_code | ASCII string (4) Possible values: AAUT, FAGN, FBNK, FCCS, FCLC, FCLG, FCQC, FCND, FCOP, FDEC, FDVO, FFRD, FHRD, FIND, FINP, FLCK, FOPD, FPAC, FRMA, FRME, FRVK, FSKP, FSLM, NNOR, ZBNK, ZCCO, ZCCS, ZCOP, ZDEC, ZDVO, ZFRD, ZMCO, ZOPD, ZSLM, ZSRO
|
BODY | tos_agreement | |
BODY | risk_rating | ASCII string (4) Risk rating of the Customer Possible values: L, M, H, X, Y, Z, N, P, Q, R, S L - Low - Preferred (Prime Customer, Preferred Account Type) M - Medium - Preferred (Prime Customer, Preferred Account Type) H - High - Premium (Prime Customer, Premium Account Type) X - X-High - Premium (Prime Customer, Premium Account Type) Y - XX-High - Standard (Non-prime Customer) Z - XXX-High - Standard (Non-prime Customer) P - XX-High - High (Non-prime Customer) Q - XX-High - Very Low (Non-prime Customer) R - XX-High - Low (Non-prime Customer) S - XX-High - Medium (Non-prime Customer) N - No Rating Assigned
|
BODY | account_number | |
BODY | customer_account_type | |
BODY | credit_limit | |
BODY | available_credit | number (18,2) Customer’s open to buy
|
BODY | originating_merchant_id | |
BODY | originating_merchant_name | |
BODY | creation_date | |
BODY | first_name | ASCII string (35) Customer’s First Name
|
BODY | last_name | ASCII string (50) Customer’s Last Name
|
BODY | card_ending_in | |
BODY | preferred_language | |
...
Type | Parameter | Details |
---|
BODY | available_credit | number (18,2) Customer’s open to buy
|
BODY | account_number | |
BODY | customer_id | |
BODY | security_qid.id | |
BODY | security_qid.text | |
BODY | address_1 | ASCII string (150) Customer Address Line 1
|
BODY | address_2 | ASCII string (143) Customer Address Line 2
|
BODY | city | ASCII string (100) Customer City
|
BODY | postal_code | ASCII string (10) Customer Postal Code
|
BODY | province | ASCII string (2) Customer Province (2 character syntax, ex. ON for Ontario) Available values: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.
|
BODY | payment_protection | |
BODY | risk_rating | ASCII string (4) Risk rating of the Customer Possible values: L, M, H, X, Y, Z, N L - Low - Preferred (Prime Customer, Preferred Account Type) M - Medium - Preferred (Prime Customer, Preferred Account Type) H - High - Premium (Prime Customer, Premium Account Type) X - X-High - Premium (Prime Customer, Premium Account Type) Y - XX-High - Standard (Non-prime Customer) Z - XXX-High - Standard (Non-prime Customer) P - XX-High - High (Non-prime Customer) Q - XX-High - Very Low (Non-prime Customer) R - XX-High - Low (Non-prime Customer) S - XX-High - Medium (Non-prime Customer) N - No Rating Assigned
|
BODY | offer_types.plan_name | |
BODY | offer_types.plan_id | |
BODY | offer_types.offer_category | ASCII string Category of the promotional plans available to the customer Available values: equal_billing, deferred_payment
|
BODY | offer_types.term_options | |
BODY | card_ending_in | |
BODY | preferred_language | |
BODY | email | ASCII string (75) This will be a masked representation of the customer’s email address This can be used to validate with the email destination with the customer for the dynamic pin on POST /client-id/{client_id}/account/{account_number}/verify (In-store)
|
BODY | phone_number | ASCII string (12) This will be the last four digits of the customer’s phone number, the rest of the digits will be masked This can be used to validate with the sms destination with the customer for the dynamic pin on POST /client-id/{client_id}/account/{account_number}/verify (In-store)
|
BODY | account_type | |
...
Code Block |
---|
|
https://{posapi_url}/flexiti/pos-api/v2.5.1/client-id/{client_id}/accounts/12345/calculate-interest |
NOTE: the /calculate-interest endpoint has been updated to version 2.5.1, reflected in the URI.
...