Resources Enums Models Clients

api-fraud 0.0.2

History | Watch

API documentation for the fraud service

Resources

Decision

Operations

Method and Path Description
POST /decision

Consumes the decision about a transaction (usually meant for manual review) and triggers OMS to process/cancel the order

Transaction

Store a transaction and give an immediate yes/no/maybe decision, if maybe send to manual review and await other endpoint

Operations

Method and Path Description
POST /transaction

Provides decision about a transaction by supplying order or other information

Headers

No headers

Imports

No imports

Enums

Banner

Our lovely store chains

Name Value Description
lat lat

s5a s5a

o5a o5a

bay bay

CustomerType

Possible types of customers

Name Value Description
guest guest

registered registered

employee employee

RecommendationCode

Enum describing the possible responses

Name Value Description
reject reject

review review

accept accept

Interfaces

No interfaces

Models

AdditionalData

Example Json: Minimal | Full

Interfaces: None

Envelope data

Field Type Required? Default Description
inAuthId uuid Yes -

Address

Example Json: Minimal | Full

Interfaces: None

General address model

Field Type Required? Default Description
name string Yes -

streetLineOne string Yes -

streetLineTwo string No -

city string Yes -

state string Yes -

zip string Yes -

country string Yes -

CreditCard

Example Json: Minimal | Full

Interfaces: None

A customer’s complete credit card information

Field Type Required? Default Description
nameOnCard string Yes -

billingAddress Address Yes -

cardType string Yes -

cardNumber string Yes -

authorizedAmount decimal Yes -

fullAmount decimal Yes -

expiryDate string Yes -

MM-YY that the credit card expires
authCode string Yes -

CVV code on the back of the card
responseCode integer Yes -

merchantId integer No -

registerNumber string No -

transactionNumber string Yes -

avsResponse string Yes -

Address Verification System response, Codes are available here: https://www.chasepaymentech.com/address_verification_service.html

Customer

Example Json: Minimal | Full

Interfaces: None

Customer model

Field Type Required? Default Description
customerType CustomerType Yes -

accountId string Yes -

creationDate date-iso8601 Yes -

firstName string Yes -

lastName string Yes -

emailAddress string Yes -

DBRecord

Example Json: Minimal | Full

Interfaces: None

Response model to OMS containing the transaction they’ve sent and the decision we’ve made

Field Type Required? Default Description
transactionId string Yes -

lastModifiedDate date-iso8601 No -

createdDate date-iso8601 No -

Date this record was first created within the database
transaction Transaction Yes -

decision Decision Yes -

Decision

Example Json: Minimal | Full

Interfaces: None

Defines decision information

Field Type Required? Default Description
transactionId string Yes -

recommendationCode RecommendationCode Yes -

crossReference uuid No -

rulesTripped string No -

totalScore integer Yes -

remarks string No -

Error

Example Json: Minimal | Full

Interfaces: None

Error response model

Field Type Required? Default Description
message string Yes -

Error description message

Example: Oops, something went wrong!
error string Yes -

Error code

Example: invalid_email

Item

Example Json: Minimal | Full

Interfaces: None

Single item

Field Type Required? Default Description
svsNumber integer Yes -

Product style number (parent number)
skuNumber integer Yes -

HBC internally generated number for items (alias SKN)
upcNumber integer No -

The number on the barcode that could be used across different retailers
classNumber integer No -

Signifies business category of an item (pants, tops, shirts, etc.)
color string No -

size string No -

currentStatus string Yes -

department integer Yes -

signOnDelivery string No -

giftWrapped boolean No -

costAmount decimal No -

marginAmount decimal No -

description string Yes -

price decimal Yes -

Price of single item
extendedPrice decimal Yes -

Total price of all items ordered
quantity integer Yes -

groupNumber integer Yes -

shippingAddress Address Yes -

shippingMethod string Yes -

shippingCountry string Yes -

Promo

Example Json: Minimal | Full

Interfaces: None

Promotion model

Field Type Required? Default Description
promotionCode string Yes -

promotionAmount decimal Yes -

Dollar amount discounted by the promotion

Transaction

Example Json: Minimal | Full

Interfaces: None

Defines data expected to come in from OMS describing a transaction

Field Type Required? Default Description
orderId string Yes -

groupId string Yes -

orderTotal decimal Yes -

shippingCost decimal Yes -

currencyCode string Yes -

storeNumber integer Yes -

salesRep string No -

lastModifiedDate date-iso8601 No -

banner Banner Yes -

creditCard CreditCard Yes -

promos [Promo] No -

items [Item] Yes -

ipAddress string No -

source string Yes -

Order source (web, store, etc)
customer Customer Yes -

additionalData AdditionalData No -

Additional envelope data sent through our system to f-s, should include InAuthId

Unions

No unions

Annotations

No annotations