API Reference
/
Portal API

NoFraud Portal API

The NoFraud Portal API includes endpoints to perform actions that would otherwise be performed manually in the NoFraud Portal UI.

The base URL for these requests is https://portal-api.nofraud.com/api/v1/transaction-update/ for both Test and Production calls.

Download OpenAPI description
portal-api.json
portal-api.yaml
Languages
Servers
Mock server
https://developers.nofraud.com/_mock/portal-api/
Production
https://portal-api.nofraud.com/api/v1/transaction-update/

Submit a customer code

Request

This process allows your system to automate the method by which phone order customer codes are submitted to the NoFraud Portal. For more information on how NoFraud screens phone orders normally, please visit our Phone Order Overview or Phone Orders for Developers to find developer specific content.

This endpoint uses the Portal API URL. Make POST requests to:

https://portal-api.nofraud.com/api/v1/transaction-update/customer-code

Bodyapplication/json
nf_tokenstringrequired
Example: "NF_prod_eda02a1aa67099c0f30b3ab937bce2a6"
customer_codestringrequired
Example: "123-456-789"
emailstring(email)required
Example: "email@example.com"
curl -i -X POST \
  https://developers.nofraud.com/_mock/portal-api/customer-code \
  -H 'Content-Type: application/json' \
  -d '{
    "nf_token": "NF_prod_eda02a1aa67099c0f30b3ab937bce2a6",
    "customer_code": "123-456-789",
    "email": "email@example.com"
  }'

Responses

OK

Bodyapplication/json
codestring

Response code

messagestring

Response message

Response
application/json
{
  "code": 200,
  "message": "customer code created successfully"
}

Report fraud

Request

After a transaction is screened by NoFraud's API and appears in the NoFraud Portal, you have the option of making an API call to NoFraud's Portal directly in order to report that a particular order was indeed fraudulent. This will trigger an alert for our team of Fraud Analysts to research and review the order.

This action will have the same effect as clicking the "Report Fraud" button when viewing a particular transaction in the NoFraud Portal.

This endpoint uses the Portal API URL. Make POST requests to:

https://portal-api.nofraud.com/api/v1/transaction-update/report-fraud

Bodyapplication/json
nf_tokenstringrequired
Example: "NF_prod_eda02a1aa67099c0f30b3ab937bce2a6"
transaction_idstringrequired
Example: "16f235a0-e4a3-529c-9b83-bd15fe722110"
curl -i -X POST \
  https://developers.nofraud.com/_mock/portal-api/report-fraud \
  -H 'Content-Type: application/json' \
  -d '{
    "nf_token": "NF_prod_eda02a1aa67099c0f30b3ab937bce2a6",
    "transaction_id": "16f235a0-e4a3-529c-9b83-bd15fe722110"
  }'

Responses

OK

Bodyapplication/json
codestring

Response code

messagestring

Response message

Response
application/json
{
  "code": 200,
  "message": "transaction successfully reported as fraudulent"
}

Cancel a transaction

Request

After a transaction is screened by NoFraud's API and appears in the NoFraud Portal, you have the option of making an API call to NoFraud's Portal directly in order to report that a particular order was canceled. This will update our system accordingly.

This action will have the same effect as clicking the "Cancel Order" button when viewing a particular transaction in the NoFraud Portal. Transactions can only be marked as canceled within 5 days of the time NoFraud initially screened the order.

This endpoint uses the Portal API URL. Make POST requests to:

https://portal-api.nofraud.com/api/v1/transaction-update/cancel-transaction

Bodyapplication/json
nf_tokenstringrequired
Example: "NF_prod_eda02a1aa67099c0f30b3ab937bce2a6"
transaction_idstringrequired
Example: "16f235a0-e4a3-529c-9b83-bd15fe722110"
curl -i -X POST \
  https://developers.nofraud.com/_mock/portal-api/cancel-transaction \
  -H 'Content-Type: application/json' \
  -d '{
    "nf_token": "NF_prod_eda02a1aa67099c0f30b3ab937bce2a6",
    "transaction_id": "16f235a0-e4a3-529c-9b83-bd15fe722110"
  }'

Responses

OK

Bodyapplication/json
codestring

Response code

messagestring

Response message

Response
application/json
{
  "code": 200,
  "message": "transaction successfully marked as canceled"
}

Submit chargeback

Request

You can submit a chargeback to NoFraud's system via a request to our Portal API for transactions which are covered by Chargeback Protection. Only transactions with a current status of either "pass" or "fraudulent" can have a chargeback submitted.

Submitting a chargeback via API is the same as clicking the "Submit Chargeback" button and submitting the associated form when viewing a particular transaction in the NoFraud Portal.

This endpoint uses the Portal API URL. Make POST requests to:

https://portal-api.nofraud.com/api/v1/transaction-update/submit-chargeback

Bodyapplication/json
nf_tokenstringrequired
Example: "NF_prod_eda02a1aa67099c0f30b3ab937bce2a6"
transaction_idstringrequired
Example: "16f235a0-e4a3-529c-9b83-bd15fe722110"
reason_codestringrequired

Chargeback reason code

Example: "F24"
due_datestringrequired

Last day documentation can be submitted to processor to dispute chargeback. Must be formatted as "YYYY-MM-DD"

Example: "2025-03-01"
notice_datestring

Date you were notified about the chargeback. Must be formatted as "YYYY-MM-DD"

Example: "2025-01-01"
reference_numberstring

Chargeback reference number

Example: "10003023578"
carrierstring

Shipping Carrier (i.e. "UPS", "FedEx", etc.)

Example: "USPS"
carrier_tracking_numberstring

Tracking number of shipment

Example: "9114901075742452019146"
notesstring

Additional chargeback notes or information

Example: "Here is some additional chargeback information."
inquirystring

Optional. Must be either "true" or "false". System assumes "false" if not present.

Example: "false"
curl -i -X POST \
  https://developers.nofraud.com/_mock/portal-api/submit-chargeback \
  -H 'Content-Type: application/json' \
  -d '{
    "nf_token": "NF_prod_eda02a1aa67099c0f30b3ab937bce2a6",
    "transaction_id": "16f235a0-e4a3-529c-9b83-bd15fe722110",
    "reason_code": "F24",
    "due_date": "2025-03-01",
    "notice_date": "2025-01-01",
    "reference_number": "10003023578",
    "carrier": "USPS",
    "carrier_tracking_number": "9114901075742452019146",
    "notes": "Here is some additional chargeback information.",
    "inquiry": "false"
  }'

Responses

OK

Bodyapplication/json
codestring

Response code

Example: 200
messagestring

Response message

Example: "chargeback successfully reported"
chargebackobject(Chargeback)
Response
application/json
{
  "code": 200,
  "message": "chargeback successfully reported",
  "chargeback": {
    "transaction_id": "16f235a0-e4a3-529c-9b83-bd15fe722110",
    "reason_code": "F24",
    "due_date": "2025-03-01",
    "notice_date": "2025-01-01",
    "reference_number": "10003023578",
    "carrier": "USPS",
    "carrier_tracking_number": "9114901075742452019146",
    "notes": "Here is some additional chargeback information.",
    "inquiry": "false"
  }
}