{"items":[{"type":"link","label":"Transaction risk screening service API","link":"/apis/risk-screening","routeSlug":"/apis/risk-screening","content":{"contentType":"overview","meta":{"name":"Transaction risk screening service API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"risk-screening.json","url":"/_bundle/apis/risk-screening.json?download"},{"kind":"download","label":"risk-screening.yaml","url":"/_bundle/apis/risk-screening.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Transaction risk screening service API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is an API reference for the Transaction Risk Screening service."}],"sectionId":"/apis/risk-screening"}],"sectionId":"/apis/risk-screening"}]}]}},{"label":"Initiate standalone fraud screening","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/risk-screening/other/request-standalone-fraud-screening","routeSlug":"/apis/risk-screening/other/request-standalone-fraud-screening","metadata":{"seo":{"title":"Initiate standalone fraud screening","description":"Performs a standalone fraud screening analysis for a transaction. All fields are optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"request-standalone-fraud-screening","name":"Initiate standalone fraud screening","isWebhook":false,"pointer":"/paths/~1transaction-risk-screenings~1standalone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate standalone fraud screening","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Performs a standalone fraud screening analysis for a transaction. All fields are optional."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RiskScreeningRequest","exampleIds":["paths/~1transaction-risk-screenings~1standalone/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/RiskScreeningRequest","exampleIds":["paths/~1transaction-risk-screenings~1standalone/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1transaction-risk-screenings~1standalone/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transaction-risk-screenings/standalone","servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/RiskScreeningRequest","exampleIds":["paths/~1transaction-risk-screenings~1standalone/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/transaction-risk-screenings/standalone","href":"other/request-standalone-fraud-screening","openApiOperationId":"request-standalone-fraud-screening","summary":"Initiate standalone fraud screening"},"isWebhook":false,"hideReplay":true,"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}],"schemaId":"components/schemas/RiskScreeningRequest","exampleIds":["paths/~1transaction-risk-screenings~1standalone/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RiskScreeningRequest","exampleIds":["paths/~1transaction-risk-screenings~1standalone/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Risk screening completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScreeningResponse","exampleIds":["paths/~1transaction-risk-screenings~1standalone/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/RiskScreeningResponse","exampleIds":["paths/~1transaction-risk-screenings~1standalone/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad request - invalid input data"},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1transaction-risk-screenings~1standalone/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RiskScreeningResponse","exampleIds":["paths/~1transaction-risk-screenings~1standalone/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiskScreeningResponse","exampleIds":["paths/~1transaction-risk-screenings~1standalone/post/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/other/request-standalone-fraud-screening"}],"panels":[]}]},"httpPath":"/transaction-risk-screenings/standalone"}],"store":{"schemaStore":{"components/schemas/RiskScreeningRequest":{"id":"components/schemas/RiskScreeningRequest","kind":"json-schema","title":"RiskScreeningRequest","data":{"type":"object","properties":{"merchantGroup":{"type":"string","description":"Your unique merchant group identifier, as assigned by PXP.","example":"GROUP123"},"merchant":{"type":"string","maxLength":20,"description":"Your unique merchant identifier, as assigned by PXP.","example":"MERCHANT123"},"site":{"type":"string","maxLength":20,"description":"Your unique site identifier, as assigned by PXP.","example":"SITE123"},"performRiskScreening":{"type":"boolean","description":"Whether to enable risk screening for this transaction.","example":true},"excludeDeviceData":{"type":"boolean","description":"Whether to exclude device fingerprinting data from analysis.","example":false},"channel":{"type":"string","maxLength":256,"description":"The channel through which the transaction was initiated.","example":"ACME_IOS_APP"},"deviceSessionId":{"type":"string","maxLength":256,"pattern":"^[0-9A-Za-z]*$","description":"The unique session identifier for the customer's end-user session on your site or app. This must be the same session ID used in the device data collection from the client-side Kount SDK."},"creationDateTime":{"type":"string","format":"date-time","description":"The date and time when the order was placed, in ISO 8601 format.","example":"2024-01-15T10:30:00Z"},"userIp":{"type":"string","format":"ipv4","description":"The customer's IPv4 address, in dotted decimal notation.","example":"192.168.1.27"},"account":{"$ref":"#/components/schemas/Account"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"},"description":"Array of details about each item in the order."},"fulfillments":{"type":"array","items":{"$ref":"#/components/schemas/Fulfillment"},"description":"Array of details about the fulfillment of the order."},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"},"description":"Array of details about the payment transactions made for the order."},"promotions":{"type":"array","items":{"$ref":"#/components/schemas/Promotion"},"description":"Array of promotions applied to this order."},"loyalty":{"$ref":"#/components/schemas/Loyalty"},"customFields":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","maxLength":256},{"type":"number"},{"type":"boolean"},{"type":"string","format":"date-time"}]},"description":"Additional custom fields, in key-value pairs."}}}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"type":"object","description":"Details about the customer's account.","properties":{"id":{"type":"string","description":"The unique identifier for the account, as chosen by you.","example":"user123456"},"type":{"type":"string","description":"The account type, as chosen by you.","example":"consumer"},"creationDateTime":{"type":"string","format":"date-time","description":"The date and time when the account was created, in ISO 8601 format.","example":"2023-06-15T08:00:00Z"},"username":{"type":"string","description":"The username or email address associated with the account.","example":"john.doe@pxp.io"},"accountIsActive":{"type":"boolean","description":"Whether the account is currently active.","example":true}}}},"components/schemas/Item":{"id":"components/schemas/Item","kind":"json-schema","title":"Item","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the item, as chosen by you.","example":"item001"},"price":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The price of the single item in the lowest currency factor. For example, the lowest currency in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is pennies, so $1.00 would have the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be a natural number including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":2999},"description":{"type":"string","description":"The description of the item being purchased.","example":"Wireless Bluetooth Headphones"},"name":{"type":"string","description":"The name of the item being purchased. Typically, this is the SKU.","example":"Premium Headphones"},"quantity":{"type":"integer","minimum":1,"description":"The quantity of the item being purchased.","example":1},"category":{"type":"string","description":"A high-level or generalised description of the item.","example":"Electronics"},"subCategory":{"type":"string","description":"A lower-level or more specific description of the item.","example":"Audio"},"isDigital":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the item is a digital good or service ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or a physical item or service ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":false},"sku":{"type":"string","description":"The item's Stock Keeping Unit identifier (SKU), when available.","example":"SKU-WBH-001"},"upc":{"type":"string","description":"The item's Universal Product Code (UPC), when available.","example":"123456789012"},"brand":{"type":"string","description":"The item's brand name.","example":"TechBrand"},"url":{"type":"string","format":"uri","description":"The URL to the item's product page.","example":"https://example.com/products/wireless-headphones"},"imageUrl":{"type":"string","format":"uri","description":"The URL to the product's image.","example":"https://example.com/images/headphones.jpg"},"isService":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the item is a service ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or a digital or physical good ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":false},"physicalAttributes":{"$ref":"#/components/schemas/PhysicalAttributes"},"descriptors":{"type":"array","items":{"type":"string"},"description":"Array of descriptive tags or keywords for the item."}}}},"components/schemas/PhysicalAttributes":{"id":"components/schemas/PhysicalAttributes","kind":"json-schema","title":"PhysicalAttributes","data":{"description":"Details about the item's physical attributes, if it's a physical good.","type":"object","properties":{"color":{"type":"string","description":"The item's colour, when there are different colour options.","example":"Black"},"size":{"type":"string","description":"The item's size, when there are different size options.","example":"Medium"},"weight":{"type":"string","description":"The item's weight, with units.","example":"250g"},"height":{"type":"string","description":"The item's height, with units.","example":"20cm"},"width":{"type":"string","description":"The item's width, with units.","example":"15cm"},"depth":{"type":"string","description":"The item's depth, with units.","example":"8cm"}}}},"components/schemas/Fulfillment":{"id":"components/schemas/Fulfillment","kind":"json-schema","title":"Fulfillment","data":{"type":"object","description":"Details about the store where the order is being fulfilled, for in-store pickups.","properties":{"type":{"type":"string","enum":["SHIPPED","DIGITAL","STORE_PICK_UP","LOCAL_DELIVERY","STORE_DRIVE_UP","IN_PERSON"],"description":"The type of fulfillment."},"status":{"type":"string","enum":["PENDING","UNFULFILLED","ON_HOLD","FULFILLED","SCHEDULED","PARTIALLY_FULFILLED","DELAYED","CANCELED"],"description":"The current status of the fulfillment."},"accessUrl":{"type":"string","nullable":true,"format":"uri","description":"The URL that the customer needs to visit to retrieve the digital good."},"store":{"$ref":"#/components/schemas/Store"},"merchantFulfillmentId":{"type":"string","description":"A unique identifier for this fulfillment, as chosen by you."},"shipping":{"$ref":"#/components/schemas/Shipping"},"items":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentItem"},"description":"Details about the item or list of items being fulfilled."},"recipientPerson":{"$ref":"#/components/schemas/RecipientPerson"}}}},"components/schemas/Store":{"id":"components/schemas/Store","kind":"json-schema","title":"Store","data":{"type":"object","nullable":true,"properties":{"id":{"type":"string","description":"A unique identifier for the store, as chosen by you."},"name":{"type":"string","description":"A human-readable name for the store, as chosen by you."},"address":{"$ref":"#/components/schemas/Address"}}}},"components/schemas/Shipping":{"id":"components/schemas/Shipping","kind":"json-schema","title":"Shipping","data":{"type":"object","description":"Details about the shipping. This should be included even for digital goods.","properties":{"shippingAmount":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of the shipping cost, in its lowest denomination. For example, the lowest denomination in USD is the penny, so $1.00 has a \"total\" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The total must be a natural number, which includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"shippingProvider":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service used to deliver the order to the recipient. If you are fulfilling the order yourself, set the value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FBM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (fulfilled by merchant). For example, if providing digital goods."},"children":[]}]}]}]},"trackingNumber":{"type":"string","description":"The tracking number from the shipping provider for shipped goods."},"shippingMethod":{"type":"string","enum":["STANDARD","EXPRESS","SAME_DAY","NEXT_DAY","SECOND_DAY"],"description":"The shipping method used."}}}},"components/schemas/FulfillmentItem":{"id":"components/schemas/FulfillmentItem","kind":"json-schema","title":"FulfillmentItem","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the item being fulfilled."},"quantity":{"type":"integer","minimum":1,"description":"The quantity of the item in this fulfillment."}}}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"type":"object","properties":{"merchantTransactionId":{"type":"string","description":"The unique identifier for this transaction, as chosen by you."},"processor":{"type":"string","description":"The name of the payment processor that processed the transaction."},"processorMerchantId":{"type":"string","description":"Your merchant ID, as assigned by the payment processor."},"subtotal":{"type":"integer","minimum":0,"description":"The total amount of the order without shipping and tax included, in its lowest denomination"},"orderTotal":{"type":"integer","minimum":0,"description":"The total amount of currency in the transaction, in its lowest denomination"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","default":"USD","description":"The currency used for the transaction, in ISO 4217 format."},"transactionStatus":{"type":"string","enum":["PENDING","AUTHORIZED","REFUSED","CAPTURED","ERROR","EXPIRED","CANCELLED","SENT_FOR_REFUND","REFUNDED","REFUND_FAILED","SETTLED","INFORMATION_REQUESTED","INFORMATION_SUPPLIED","CHARGED_BACK","CHARGEBACK_REVERSED","DISPUTE_EXPIRED","DISPUTE_RESERVE_RELEASED","DISPUTED_FUNDS_HELD","DISPUTED_FUNDS_RELEASED"],"description":"The current status of the transaction."},"payment":{"$ref":"#/components/schemas/Payment"},"tax":{"$ref":"#/components/schemas/Tax"},"billedPerson":{"$ref":"#/components/schemas/BilledPerson"},"authorizationStatus":{"$ref":"#/components/schemas/AuthorizationStatus"},"items":{"type":"array","items":{"$ref":"#/components/schemas/TransactionItem"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array indicating which of the items present in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array were paid for in this transaction."},"children":[]}]}]}]}}}},"components/schemas/Payment":{"id":"components/schemas/Payment","kind":"json-schema","title":"Payment","data":{"type":"object","properties":{"type":{"type":"string","enum":["APAY","CREDIT_CARD","DEBIT_CARD","PYPL","CHEK","NONE","TOKEN","GDMP","GOOG","BLML","GIFT","BPAY","NETELLER","GIROPAY","ELV","MERCADE_PAGO","SEPA","INTERAC","CARTE_BLEUE","POLI","SKRILL","SOFORT","AMZN","SAMPAY","ALIPAY","WCPAY","CRYPTO","KLARNA","AFTRPAY","AFFIRM","SPLIT","FBPAY"],"description":"The type of payment method used."},"paymentToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment token submitted for order, in the format of a KHASH (credit card, payer ID, routing/transit, MICR, and account number).The KHASH value is hashed with a salted SHA256. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":",  then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value should be left empty. For post-auth calls only: if the credit card information isn't available and a tokenised value is returned from the payment processor, set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and send the token returned from the payment processor as a KHASH in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"bin":{"type":"string","maxLength":8,"description":"The card's Bank Identification Number (BIN). This is made up of the first 6 or 8 digits of a credit or debit card."},"last4":{"type":"string","pattern":"^[0-9]{4}$","description":"The last 4 digits of card's Primary Account Number (PAN)."}}}},"components/schemas/Tax":{"id":"components/schemas/Tax","kind":"json-schema","title":"Tax","data":{"type":"object","properties":{"isTaxable":{"type":"boolean","description":"Whether the transaction is subject to tax."},"taxableCountryCode":{"type":"string","pattern":"^[A-Z]{2}$","description":"The country code of the taxable country, in ISO 3166 format."},"taxAmount":{"type":"integer","minimum":0,"description":"The amount that was charged in taxes for this order, in the currency's lowest denomination."},"outOfStateTaxAmount":{"type":"integer","minimum":0,"description":"The amount that was charged in out-of-state taxes for this order, in the currency's lowest denomination."}}}},"components/schemas/AuthorizationStatus":{"id":"components/schemas/AuthorizationStatus","kind":"json-schema","title":"AuthorizationStatus","data":{"type":"object","properties":{"authResult":{"type":"string","enum":["Approved","Declined","Unknown","Error"],"description":"The result of the authorisation attempt, as returned by the payment processor."},"dateTime":{"type":"string","format":"date-time","description":"The date and time when the authorisation was processed, in ISO 8601 format."},"declineCode":{"type":"string","nullable":true,"description":"The decline reason code returned by the payment provider, if the payment was declined."},"processorAuthCode":{"type":"string","description":"The authorisation code returned by the payment processor."},"processorTransactionId":{"type":"string","description":"The unique identifier used by the payment processor or gateway for the order."},"acquirerReferenceNumber":{"type":"string","pattern":"^[0-9]{11}$","description":"A unique 11-digit number for a credit or debit card transaction."},"verificationResponse":{"$ref":"#/components/schemas/VerificationResponse"}}}},"components/schemas/VerificationResponse":{"id":"components/schemas/VerificationResponse","kind":"json-schema","title":"VerificationResponse","data":{"type":"object","properties":{"avsStatus":{"type":"string","enum":["A","B","C","D","E","F","G","I","K","L","M","N","O","P","R","S","T","U","W","X","Y","Z"],"description":"The Address Verification Service (AVS) response returned by the payment processor."},"cvvStatus":{"type":"string","enum":["Match","Unknown","NoMatch",""],"description":"The Card Verification Value (CVV, CVS) response returned by the payment processor."}}}},"components/schemas/TransactionItem":{"id":"components/schemas/TransactionItem","kind":"json-schema","title":"TransactionItem","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier of the item that was specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]},"quantity":{"type":"integer","minimum":1,"description":"The quantity of this item that were paid for in this transaction."}}}},"components/schemas/Promotion":{"id":"components/schemas/Promotion","kind":"json-schema","title":"Promotion","data":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier for the promotion, as chosen by you."},"description":{"type":"string","description":"A human-readable description of the promotion, as chosen by you."},"status":{"type":"string","description":"The current status of the promotion, as chosen by you."},"statusReason":{"type":"string","description":"The reason for the current promotion status."},"credit":{"$ref":"#/components/schemas/promotionalCredit"},"discount":{"$ref":"#/components/schemas/Discount"}}}},"components/schemas/Discount":{"id":"components/schemas/Discount","kind":"json-schema","title":"Discount","data":{"type":"object","properties":{"percentage":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage of the total amount that was reduced due to the promotion being applied, represented as a floating point number. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means 10% discounted."},"children":[]}]}]}],"example":0.1},"amount":{"type":"integer","minimum":0,"description":"The amount that the total was reduced by due to the promotion, in the currency's lowest denomination."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","default":"USD","description":"The currency used for the promotional discount, in ISO 4217 format."}}}},"components/schemas/Loyalty":{"id":"components/schemas/Loyalty","kind":"json-schema","title":"Loyalty","data":{"type":"object","description":"Details about a credit that was applied from a loyalty account.","properties":{"id":{"type":"string","description":"The unique identifier for the loyalty transaction."},"description":{"type":"string","description":"A description of the loyalty programme being applied."},"credit":{"$ref":"#/components/schemas/loyaltyCredit"}}}},"components/schemas/promotionalCredit":{"id":"components/schemas/promotionalCredit","kind":"json-schema","title":"promotionalCredit","data":{"type":"object","description":"Details about the promotional credit that was applied to the order.","nullable":true,"properties":{"creditType":{"type":"string","description":"The type of credit, as chosen by you."},"amount":{"type":"integer","minimum":0,"description":"The amount of the total order that was paid for through a credit, in the currency's lowest denomination."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","default":"USD","description":"The currency used for the credit, in ISO 4217 format."}}}},"components/schemas/loyaltyCredit":{"id":"components/schemas/loyaltyCredit","kind":"json-schema","title":"loyaltyCredit","data":{"type":"object","description":"Details about the loyalty credit that was applied to the order.","nullable":true,"properties":{"creditType":{"type":"string","description":"The type of credit, as chosen by you."},"amount":{"type":"integer","minimum":0,"description":"The amount of the total order that was paid for through a credit, in the currency's lowest denomination."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","default":"USD","description":"The currency used for the credit, in ISO 4217 format."}}}},"components/schemas/BilledPerson":{"id":"components/schemas/BilledPerson","kind":"json-schema","title":"BilledPerson","data":{"type":"object","description":"Details about the person who placed the order.","properties":{"name":{"$ref":"#/components/schemas/BilledPersonName"},"emailAddress":{"type":"string","format":"email","description":"The billed person's email address."},"phoneNumber":{"type":"string","description":"The billed person's phone number."},"dateOfBirth":{"type":"string","format":"date","description":"The billed person's date of birth.","example":"1990-05-15"},"address":{"$ref":"#/components/schemas/Address"}}}},"components/schemas/RecipientPerson":{"id":"components/schemas/RecipientPerson","kind":"json-schema","title":"RecipientPerson","data":{"type":"object","description":"Details about the order's recipient.","properties":{"name":{"$ref":"#/components/schemas/RecipientPersonName"},"emailAddress":{"type":"string","format":"email","description":"The recipient's email address.","example":"john.doe@example.com"},"phoneNumber":{"type":"string","description":"The recipient's phone number.","example":"+1-555-123-4567"},"dateOfBirth":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recipient's date of birth ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"1990-05-15"},"address":{"$ref":"#/components/schemas/Address"}}}},"components/schemas/BilledPersonName":{"id":"components/schemas/BilledPersonName","kind":"json-schema","title":"BilledPersonName","data":{"type":"object","description":"Details about the billed person's name.","properties":{"first":{"type":"string","description":"The billed person's first name."},"middle":{"type":"string","description":"The billed person's middle name or initial."},"family":{"type":"string","description":"The billed person's last name/family name."},"prefix":{"type":"string","description":"The prefix of the billed person's name."},"suffix":{"type":"string","nullable":true,"description":"The suffix of the billed person's name."},"preferred":{"type":"string","description":"The billed person's preferred name."}}}},"components/schemas/RecipientPersonName":{"id":"components/schemas/RecipientPersonName","kind":"json-schema","title":"RecipientPersonName","data":{"type":"object","description":"Details about the recipient's name.","properties":{"first":{"type":"string","description":"The recipient's first name.","example":"John"},"middle":{"type":"string","description":"The recipient's middle name or initial.","example":"A"},"family":{"type":"string","description":"The recipient's last name/family name.","example":"Doe"},"prefix":{"type":"string","description":"The prefix of the recipient's name.","example":"Mr"},"suffix":{"type":"string","nullable":true,"description":"The suffix of the recipient's name.","example":null},"preferred":{"type":"string","description":"The recipient's preferred name.","example":"John"}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","description":"Details about the address.","properties":{"line1":{"type":"string","description":"The first line of the address."},"line2":{"type":"string","description":"The second line of the address."},"city":{"type":"string","description":"The city of the address."},"region":{"type":"string","description":"The state, province, or region code of the address."},"countryCode":{"type":"string","pattern":"^[A-Z]{2}$","description":"The country of the address, in ISO 3166-1 alpha-2 format."},"postalCode":{"type":"string","description":"The postal or ZIP code of the address."}}}},"components/schemas/RiskScreeningResponse":{"id":"components/schemas/RiskScreeningResponse","kind":"json-schema","title":"RiskScreeningResponse","data":{"type":"object","description":"Details about the risk screening response received from the provider.","properties":{"riskScreeningId":{"type":"string","description":"The unique identifier for this risk screening request.","example":"e721acfa-f844-4bec-9007-47eb07dcb117"},"providerResults":{"type":"object","description":"Details about the results of the risk screening.","properties":{"kount":{"type":"object","properties":{"decision":{"type":"string","description":"The risk decision returned by Kount.","example":"APPROVE"},"riskScore":{"type":"integer","description":"The risk score returned by Kount.","example":90},"rawResponse":{"type":"string","description":"The raw JSON response from Kount, as a string.","example":"{\"version\": \"v2.42.0\", \"order\": {\"orderId\": \"7DQ5JFWQB5WKPRBT\", \"merchantOrderId\": \"Yqwh50T47EuQB0frB9yxFw\", \"channel\": \"ACME_IOS_APP\", \"deviceSessionId\": \"\", \"creationDateTime\": \"2019-08-24T14:15:22+00:00 \", \"riskInquiry\": {\"decision\": \"APPROVE \", \"omniscore\": 5, \"persona\": {\"uniqueCards\": 2, \"uniqueDevices\": 8, \"uniqueEmails\": 5}, \"device\": null, \"segmentExecuted\": {\"segment\": {\"id\": \"1eda9703-5b34-47ac-a01b-09f509642896\", \"name\": \"Default\", \"priority\": 1}, \"policiesExecuted\": [], \"tags\": []}}, \"transactions\": [{\"transactionId\": \"7DQ5JFWQB5WKPRBT#0\", \"merchantTransactionId\": \"d121ea2210434ffc8a90daff9cc97e76\"}], \"fulfillment\": []}}"}}}}}}}}},"exampleStore":{"paths/~1transaction-risk-screenings~1standalone/post/requestBody/content/application~1json/example":{"value":{"merchantGroup":"GROUP123","merchant":"MERCH123","site":"SITE123","performRiskScreening":true,"excludeDeviceData":false,"channel":"web","deviceSessionId":"d121ea2210434ffc8a90daff9cc97e76","creationDateTime":"2024-01-15T10:30:00Z","userIp":"192.168.1.100","account":{"id":"user123456","type":"registered","creationDateTime":"2023-06-15T08:00:00Z","username":"john.doe@pxp.io","accountIsActive":true},"items":[{"id":"item001","price":2999,"description":"Wireless Bluetooth Headphones","name":"Premium Headphones","quantity":1,"category":"Electronics","subCategory":"Audio","isDigital":false,"sku":"SKU-WBH-001","upc":"123456789012","brand":"TechBrand","url":"https://example.com/products/wireless-headphones","imageUrl":"https://example.com/images/headphones.jpg","physicalAttributes":{"color":"Black","size":"Medium","weight":"250g","height":"20cm","width":"15cm","depth":"8cm"},"descriptors":["wireless","bluetooth","noise-cancelling"],"isService":false}],"fulfillments":[{"type":"SHIPPED","shipping":{"shippingAmount":599,"shippingProvider":"FedEx","trackingNumber":"1234567890123456","shippingMethod":"STANDARD"},"items":[{"id":"item001","quantity":1}],"status":"PENDING","accessUrl":null,"store":null,"recipientPerson":{"name":{"first":"John","middle":"A","family":"Doe","prefix":"Mr","suffix":null,"preferred":"John"},"emailAddress":"john.doe@example.com","phoneNumber":"+1-555-123-4567","address":{"line1":"123 Main Street","line2":"Apt 4B","city":"New York","region":"NY","countryCode":"US","postalCode":"10001"},"dateOfBirth":"1990-05-15"},"merchantFulfillmentId":"FULFILL-001"}],"transactions":[{"merchantTransactionId":"TXN-20240115-001","processor":"stripe","processorMerchantId":"acct_1234567890","payment":{"type":"CREDIT_CARD","paymentToken":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0e1f2","bin":"424242","last4":"4242"},"subtotal":2999,"orderTotal":3598,"currency":"USD","tax":{"isTaxable":true,"taxableCountryCode":"US","taxAmount":240,"outOfStateTaxAmount":0},"billedPerson":{"name":{"first":"John","middle":"A","family":"Doe","prefix":"Mr","suffix":null,"preferred":"John"},"emailAddress":"john.doe@example.com","phoneNumber":"+1-555-123-4567","address":{"line1":"123 Main Street","line2":"Apt 4B","city":"New York","region":"NY","countryCode":"US","postalCode":"10001"},"dateOfBirth":"1990-05-15"},"transactionStatus":"AUTHORIZED","authorizationStatus":{"authResult":"Approved","dateTime":"2024-01-15T10:30:15Z","verificationResponse":{"avsStatus":"Y","cvvStatus":"Match"},"declineCode":null,"processorAuthCode":"AUTH123456","processorTransactionId":"pi_1234567890abcdef","acquirerReferenceNumber":"40614857370"},"items":[{"id":"item001","quantity":1}]}],"promotions":[{"id":"PROMO-WINTER2024","description":"Winter Sale - 10% off electronics","status":"active","statusReason":"promotion_applied","discount":{"percentage":0.1,"amount":300,"currency":"USD"},"credit":null}],"loyalty":{"id":"LOYALTY-12345","description":"Premium Member Rewards","credit":{"creditType":"points","amount":150,"currency":"USD"}},"customFields":{"example-custom-field-1":"AFF-001"}},"id":"paths/~1transaction-risk-screenings~1standalone/post/requestBody/content/application~1json/example"},"paths/~1transaction-risk-screenings~1standalone/post/responses/200/content/application~1json/example":{"value":{"riskScreeningId":"e721acfa-f844-4bec-9007-47eb07dcb117","providerResults":{"kount":{"decision":"APPROVE","riskScore":90,"rawResponse":"{\"version\": \"v2.42.0\", \"order\": {\"orderId\": \"7DQ5JFWQB5WKPRBT\", \"merchantOrderId\": \"Yqwh50T47EuQB0frB9yxFw\", \"channel\": \"ACME_IOS_APP\", \"deviceSessionId\": \"\", \"creationDateTime\": \"2019-08-24T14:15:22+00:00 \", \"riskInquiry\": {\"decision\": \"APPROVE \", \"omniscore\": 5, \"persona\": {\"uniqueCards\": 2, \"uniqueDevices\": 8, \"uniqueEmails\": 5}, \"device\": null, \"segmentExecuted\": {\"segment\": {\"id\": \"1eda9703-5b34-47ac-a01b-09f509642896\", \"name\": \"Default\", \"priority\": 1}, \"policiesExecuted\": [], \"tags\": []}}, \"transactions\": [{\"transactionId\": \"7DQ5JFWQB5WKPRBT#0\", \"merchantTransactionId\": \"d121ea2210434ffc8a90daff9cc97e76\"}], \"fulfillment\": []}}"}}},"id":"paths/~1transaction-risk-screenings~1standalone/post/responses/200/content/application~1json/example"}},"securitySchemeStore":{},"servers":[{"url":"https://api-services.pxp.io/api/v1","description":"Production environment"},{"url":"https://api-services.test.pxp.io/api/v1","description":"Sandbox environment"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/apis/risk-screening","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/risk-screening.json?download"},{"url":"/_bundle/apis/risk-screening.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Transaction risk screening service API","description":"This is an API reference for the Transaction Risk Screening service."}},"baseSlug":"/apis/risk-screening","routesMapping":{}}