BuyerCheck (buyercheck.bg) is a cash on delivery fraud prevention software that helps online stores reduce their losses on cash on delivery orders by providing a score (0-100) of the likelyhood a given customer will pay for his order upon delivery.
\nThe full process of integrating our API is the following:
\nCreate a webhook (example) on your store to receive order data asynchronously from us
\nSetup your store using the Onboard Store (/onboard-store routes)
\nPerform a one time sync of all your store historical orders, by processing and submitting your past orders to us (/submit-order-data route)
\n(Optional) Before accepting an order, check the risk of the customer and conditionally disable COD payment method (/check-risk routes)
\nUpon order creation, send us the order data to get a full risk report (/submit-order-data routes. We will send the risk report on your webhook so your checkout is not slowed down)
\nAt some point if you decide to stop using BuyerCheck, send us a POST requet on the /onboard-store/uninstall route
\nIf you use Shopify, WooCommerce or OpenCart you can simply use our apps or plugins:
\n\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"49373886","collectionId":"9fd93eef-3d28-4024-b330-e287ac830b8a","publishedId":"2sB3QQJo4M","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-19T11:51:37.000Z"},"item":[{"name":"Get Store Categories","event":[{"listen":"test","script":{"id":"3023e9c7-78dc-4366-97cd-461270790c44","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"daf91b7a-533b-45ac-8e31-026dab220941","request":{"method":"GET","header":[],"url":"https://api.buyercheck.bg/onboard-store","description":"This is a GET request and it is used to \"get\" the available store categories that you can choose from in the next step - to setup your store.
\nA successful GET response will have a 200 OK status, and should include a response body of JSON data with the available categories (keys) and their human-friendly names.
This is a POST request, submitting the store configuration data to our API.
\nThe required fields are:
\ndomain (the domain of your store)
\napi_user (the email of your account)
\ncategory (one of the category keys, from the GET /onboard-store request)
\nraw_data_consent (bool, if you consent to share us raw data for enhanced risk checks)
\nexcluded_test_emails (an array of emails that you or staff have used or plan to use in the future for test orders)
\nexcluded_test_phones (an array of phones that you or staff have used or plan to use in the future for test orders)
\nwebhook_url (the endpoint that we should send the processed orders)
\nwebhook_secret (the secret to access the webhook endpoint)
\nA successful POST request typically returns a 200 OK response code.
This is a POST request that you should trigger when you uninstall BuyerCheck. This is important so we can be compliant with GDPR and other laws.
\nThe required fields are:
\ndomain (your store domain)
\napi_user (the email of your account)
\nA successful POST request typically returns a 200 OK response code.
This is a POST request that submits an order to us on creation. You should also perform an initial sync of your store past orders, by passing the old orders with either successful or canceled status for an enhanced order risk detection.
\nThe required fields are:
\nstore_id (domain of your store)
\napi_user (the email of your account)
\norders (an array of objects; max 25 orders)
\nEach order contains the following fields:
\nphone (starting with 088 or +359; no spaces)
\norder_status (pending/successful/cancelled - look the order status map below)
\namount (float or int)
\npending_amount (the amount that is pending; if the order is successful/cancelled put 0)
\norder_id (the ID of the order in your system)
\nip_hash (sha256 hash of the IP address of the customer)
\ndevice_hash (optional; sha256 of the user-agent of the customer)
\ncreated_at (ISO 8601 date of when the order was created, example: \"2025-10-19T08:44:02Z\")
\nOrder Status Map
\nWe accept only 3 order statuses, so you should use them in a way similar to this
\npending - use when the order is about to be processed by your store up until the moment it has been received or returned by the customer.
\nsuccessful - use only if the customer has received the order and you have received payment for it.
\ncanceled - use when the order failed because of the customer - they didn't pick up the order from the courier or they returned it or they asked for a refund
\nA successful POST request typically returns a 200 OK response code.
This is a POST request that you can trigger during the checkout of the customer - when they have filled at least their email and their phone so you can get them checked and based on our response Show or Hide the Cash on Delivery payment option.
\nThe required fields are:
\nstore_id (domain of your store)
\napi_user (the email of your account)
\nemail (of the customer)
\nphone (of the customer; starting with 08 or +359)
\namount (the order amount; float or int)
\nip_hash (sha256 hash of the customer IP address)
\ndevice_hash (sha256 hash of the customer user agent)
\nA successful POST request typically returns a 200 OK response code with the body of the request containing:
risk_score (0-100 chance of success of the order)
\nrecommended_action (one of \"Process\", \"Verify\", \"Cancel\")
\nrisk_details (explanation of our risk score)
\n