{"openapi":"3.0.3","info":{"title":"Signifyd API","version":"3.0","contact":{"name":"Implementations Team","email":"support@signifyd.com"},"description":"The Signifyd REST API. Please see https://developer.signifyd.com/main/reference for more details."},"servers":[{"url":"https://api.signifyd.com/v3","description":"Production"}],"security":[{"Server-Side-Auth":[]}],"tags":[{"name":"Purchases","description":"Use the Purchases APIs to execute either PreAuth or PostAuth flows when calling into Signifyd, and to retrieve the decisions provided on each Order. For each PreAuth order, you will make at least 2 API calls, a `Checkout` call prior to payment authorization and a `Transaction` after authorization. For each PostAuth order, you will make a `Sale` call after the payment has been authorized with your Payment Gateway."},{"name":"Purchase Management","description":"APIs under the Purchase Management namespace record events against an existing Order. These events are linked by an `orderId`, modifying the Order entity that was created in the `Sale` or `Checkout` event."},{"name":"Return","description":"APIs under the Return namespace record events that represent attempts or executions of returns, exchanges, and/or refunds of an order. These events are linked by an `orderId`, modifying the Order entity that was created in the `Sale` or `Checkout` event.\nFor returns that Signifyd evaluates, there will always be two calls--one for evaluation via the Attempt Return endpoint, and one via the the Execute Return endpoint to let us know what your company decided to do after that.\nFor returns we do not evaluate, there will be no update, as Signifyd is not in the loop, only a single call to the Record Return endpoint."},{"name":"Returns & Appeasements","description":"APIs under the Returns & Appeasements namespace support every stage of the post-purchase journey — from intent capture to feedback and fraud labeling. Merchants can choose a decisioned or non-decisioned path and flexibly log data depending on their operational setup."},{"name":"Chargebacks","description":"APIs under the Chargebacks namespace record events that represent Chargeback creation and updates"},{"name":"Organizations","description":"This entity is a grouping of `Teams` for Billing purposes."},{"name":"Partners","description":"A `Partner` is an entity that is allowed to create `Organizations`, `Teams`, and `Users` in the Signifyd system. If a `Partner` creates one of these entities, the `Partner` has full control over it. `Users` can be added as members with roles to an `Organization`, `Team`, or the `Partner` itself. `Team` members can access information regarding that `Team` and have their own level of privilege for a given `Team`. `Organizations` are a way of grouping `Teams`. `Organization` members can access information for all `Teams` that belong to that `Organization` and have a configurable default level of privilege that can be overridden at the level of a specific `Team`. `Partner` members can access information for all `Teams` belonging to all `Organizations` belonging to the `Partner` and have a configurable default level of privilege that can be overridden at a lower level."},{"name":"Teams","description":"Typically equates to a single merchant. Orders are submitted to Signifyd under that `Team` and `Users` belonging to that `Team` can access those orders in the [Signifyd Console](http://app.signifyd.com)"},{"name":"Users","description":"Users of a `Partners` entities."},{"name":"Openings","description":"APIs under the Account Openings namespace record events that represent the moment a user submits your signup form  — whether on web, mobile, or via a support agent — before creating the account in your database."},{"name":"Modifications","description":"APIs under the AccountModifications namespace record events that represent attempts to modify a user account in your system."},{"name":"Logins","description":"APIs under the Logins namespace record events that represent Authentication Attempts into your system."},{"name":"Webhook Management","description":"Use the Webhooks APIs to create and manage the subscriptions to the webhooks defined above.\n"},{"name":"Session Intelligence","description":"API used to retrieve the device, browser, and navigation signals Signifyd profiled for a session."}],"paths":{"/orders/events/returns/attempts":{"post":{"summary":"Attempt Return","operationId":"AttemptReturn","description":"Use this endpoint to solicit an evaluation from Signifyd when the customer is requesting a refund, exchange, and/or a return. The response contains the checkpointAction, which will drive any merchant workflow you have configured\n\n*Note*: using this API does NOT cancel any Guarantee associated with the corresponding order investigation. \n\nTo send Signifyd information about return/refund/exchanges that will *not* be evaluated, use the Record Return API.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttemptReturn"}}}},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttemptReturnResponse"}}},"description":"","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Return"]}},"/orders/events/returns/executions":{"post":{"summary":"Execute Return","operationId":"ExecuteReturn","description":"Use this endpoint to inform Signifyd of subsequent actions on a return/refund/exchange request that was previously submitted for evaluation via the Attempt Return API. Integration of this endpoint is required if your organization has subscribed to Returns Abuse Prevention coverage from Signifyd.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteReturn"}}}},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteReturnResponse"}}},"description":"If an action on a Return has already been executed in the Signifyd system with the same orderId and returnId, then no updates to the Return will occur. We will simply return the existing Return details.","headers":{}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteReturnResponse"}}},"description":"Return executed","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Return"]}},"/orders/events/returns/records":{"post":{"summary":"Record Return","operationId":"RecordReturn","description":"Call this endpoint to record a return, exchanges, cancel a guarantee (within 30 days of order placement) and/or refund that does not need a decision from Signifyd.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordReturn"}}}},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordReturnResponse"}}},"description":"","headers":{}},"204":{"$ref":"#/components/responses/NoContent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Return","Purchase Management"]}},"/orders/events/returns/feedback":{"post":{"summary":"Return Feedback","operationId":"ReturnFeedback","description":"Use this endpoint to provide Signifyd with information regarding the quality of a return/refund/exchange (i.e. if it was later discovered to be an \"abusive\" return or a confirmed \"good\" return). If your company is currently performing any analysis on the quality of its returns, sending that information via this endpoint will become available to custom policies in created in Signifyd's Decision Center and appear in our Insights dashboards.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnFeedback"}}}},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnFeedbackResponse"}}},"description":"If Feedback has been created in the Signifyd system with the same orderId and returnId, then no updates to the Feedback will occur. We will simply return the existing Feedback details.","headers":{}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReturnFeedbackResponse"}}},"description":"Feedback for the order and return is created","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Return"]}},"/orders/events/postsale/actions":{"post":{"summary":"Create PostSale Requested Action","operationId":"CreatePostSaleRequestedAction","description":"Use this to log the initiation of a return, refund, exchange, or appeasement request. \n\nThis call captures the buyer's intent, allows for Signifyd evaluation (when desired), and anchors all downstream updates and feedback. \n\nCall this endpoint when:\n  - A buyer initiates a return from a self-service portal\n  - A support agent logs a refund request via phone/chat/email\n  - A return is triggered internally (e.g., loyalty appeasement, waiver)\n\n\nIf needed, use the `infoOnly` flag to specify that no Signifyd evaluation should take place.\n\nThis is required as the first step in most real-time return and refund flows.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePostSaleRequestedActionBody"}}}},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePostSaleRequestedActionResponse"}}},"description":"","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"409":{"$ref":"#/components/responses/ConflictWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Returns & Appeasements"]},"put":{"summary":"Update PostSale Action","operationId":"UpdatePostSaleAction","description":"Use this to report status changes or final actions taken on a post-sale action. \n\nCommon updates include:\n  - Refund issued\n  - Replacement sent\n  - Request canceled or declined\n  - Guarantee cancellation when status is `REFUNDED` or `PARTIAL_SETTLEMENT`\n\n\nUpdate PostSale Action helps Signifyd track request outcomes, refund timing (e.g., instant vs post-verification), and alignment with policies. \n\nThis call is important to:\n  - Close the loop on Create PostSale Requested Action\n  - Trigger guarantee cancellation logic (when applicable)\n\n\nCall this as the request progresses through stages (e.g., `OPEN` → `IN_ANALYSIS` → `REFUNDED`).","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePostSaleActionBody"}}}},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePostSaleActionResponse"}}},"description":"","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Returns & Appeasements"]}},"/orders/events/postsale/actions/record":{"post":{"summary":"Record PostSale Action","operationId":"RecordPostSaleAction","description":"Use this when the entire return, refund, or appeasement has already been completed and you’re sending the outcome retrospectively.\n\nThis is the right choice for:\n  - Batch ingestion of historical return/refund data\n  - In-store returns (BORIS) where online events are logged post-fact\n  - Use cases where Create and Update were not called in real-time\n\n\nIt supports:\n  - Guarantee cancellation if the status is `REFUNDED` or `PARTIAL_SETTLEMENT`\n  - Partial refund logic via `amount` field\n  - Matching to the original `orderId` and Signifyd guarantee\n\n\nRecord PostSale Action replaces Create + Update in one step. Do not use it in combination with the above two.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordPostSaleActionBody"}}}},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordPostSaleActionResponse"}}},"description":"","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"409":{"$ref":"#/components/responses/ConflictWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Returns & Appeasements"]}},"/orders/events/postsale/actions/feedback":{"post":{"summary":"Submit PostSale Action Feedback","operationId":"SubmitPostSaleActionFeedback","description":"Use this to report the quality of a return once the item is received, inspected, or confirmed. This feedback trains Signifyd’s models and powers insights dashboards.\n\nUse cases include:\n  - Indicating whether returned items were fraudulent or abusive\n  - Labeling returns that were fully legitimate\n  - Flagging package tampering, item switches, or serial return behavior\n\n\nMerchants specify granular `disposition` fields per item (e.g., `MISSING`, `DAMAGED`, `AS_EXPECTED`) and can optionally include `returnOutcome` (e.g., `GOOD`, `FRAUD`, `ABUSIVE`).\n\nThis endpoint is essential for merchants participating in Returns Insights, Returns Fraud prevention, or policy-triggered automations.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitPostSaleActionFeedbackBody"}}}},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitPostSaleActionFeedbackResponse"}}},"description":"If Feedback has been created in the Signifyd system with the same orderId and returnId, then no updates to the Feedback will occur. We will simply return the existing Feedback details.","headers":{}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitPostSaleActionFeedbackResponse"}}},"description":"Feedback for the order and return is created","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Returns & Appeasements"]}},"/accounts/events/openings":{"post":{"summary":"Account Opening","description":"The Account Opening API is designed to detect and prevent fake accounts, bots, and synthetic identity abuse before an account is created.  It analyzes various attributes including behavioral, device, identity, and velocity signals in real time to assess the trustworthiness of a signup attempt.  The API returns a recommended action, enabling businesses to protect their platform from the first user interaction.\n\nUse this endpoint at the moment a user submits your signup form, but before creating the account in your system.  By incorporating this check into your signup flow, you can intercept high-risk events and enforce tailored interventions like additional verification or outright blocking.","operationId":"AccountOpening","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOpeningRequest"}}},"description":"","required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"},{"$ref":"#/components/parameters/AccountIntegrityTestDecisionHeader"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOpeningResponse"}}},"description":"Response if an Account Opening event has already been created in the Signifyd system with the same accountOpeningId. No updates will occur and we will return the existing decision.","headers":{}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOpeningResponse"}}},"description":"Response if the request resulted in a new Account Opening event in the Signifyd system.","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Openings"]}},"/accounts/events/openings/feedback":{"post":{"summary":"Account Opening Feedback","description":"The Account Opening Feedback API allows merchants to send the final outcome of a signup attempt back to Signifyd. This feedback helps close the loop between our real-time recommendations and what actually happened in production, enabling more accurate future decisions and better alignment with real-world outcomes.\nUse this endpoint once the signup flow has fully resolved, whether the user completed verification, was denied, or abandoned. The feedback should reflect the actual user outcome, not speculative risk or downstream behavior.","operationId":"AccountOpeningFeedback","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOpeningFeedbackRequest"}}},"description":"","required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOpeningFeedbackResponse"}}},"description":"Response if the feedback was successfully recorded.","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Openings"]}},"/accounts/events/modifications":{"post":{"summary":"Account Modification","description":"The Account Modification API is designed to detect risky changes made to user accounts after login - especially in  sessions that may have been compromised. It analyzes behavioral, device, and contextual signals in real time  to assess the legitimacy of sensitive updates such as email, password, or payment method changes. The API  returns a recommended action, enabling proactive intervention before downstream fraud occurs.\n\nUse this endpoint when a user attempts to update sensitive account information, such as changing their email,  password, address, or stored payment method. By incorporating this check into your modification flow,  you can identify mid session ATO behavior and prevent attacks like card testing.","operationId":"AccountModification","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountModificationRequest"}}},"description":"","required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"},{"$ref":"#/components/parameters/AccountIntegrityTestDecisionHeader"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountModificationResponse"}}},"description":"Response if the modification ID already exists, containing the existing decision.","headers":{}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountModificationResponse"}}},"description":"Response if the modification was successfully recorded and a new decision was created.","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Modifications"]}},"/accounts/events/modifications/feedback":{"post":{"summary":"Account Modification Feedback","description":"The Account Modification Feedback API captures the final outcome of sensitive account changes, such as password updates or contact info changes. By sending this feedback, merchants help Signifyd better understand the effectiveness of risk recommendations and enhance future detection.\nUse this endpoint once the account modification flow is complete, whether the change was applied, blocked, or required verification. The feedback should reflect what actually happened during the session.","operationId":"AccountModificationFeedback","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountModificationFeedbackRequest"}}},"description":"","required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountModificationFeedbackResponse"}}},"description":"Response if the feedback was successfully recorded.","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Modifications"]}},"/accounts/events/logins":{"post":{"summary":"Account Login","description":"The Account Login API is designed to detect and prevent account takeover (ATO) attempts in real time by analyzing  device, session, and behavioral signals during the login process. It returns a recommended action enabling  targeted interventions that stop fraud without harming trusted users.\n\nUse this endpoint at the moment a user submits their login credentials, whether the login attempt succeeds or fails.  Calling the API for both outcomes allows Signifyd to detect patterns like credential stuffing, phishing attempts,  and anomalous behavior across devices and IPs. By embedding this check into your login flow, you can step up or  block high--risk login attempts while maintaining a seamless experience for trusted users.","operationId":"RecordLogin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordLoginRequest"}}},"description":"","required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"},{"$ref":"#/components/parameters/AccountIntegrityTestDecisionHeader"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponse"}}},"description":"Response if the login ID already exists, containing the existing decision.","headers":{}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponse"}}},"description":"Response if the login was successfully recorded and a new decision was created.","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Logins"]}},"/accounts/events/logins/feedback":{"post":{"summary":"Account Login Feedback","description":"The Account Login Feedback API allows merchants to report the final result of a login attempt. This feedback enables Signifyd to compare our real-time recommendations with actual outcomes, improving accuracy and refining risk signals over time.\nUse this endpoint after the login attempt has fully played out, whether the user passed step-up verification, failed, or proceeded normally. The feedback should represent the true user result, not future behavior or assumptions.","operationId":"AccountLoginFeedback","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountLoginFeedbackRequest"}}},"description":"","required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountLoginFeedbackResponse"}}},"description":"Response if the feedback was successfully recorded.","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Logins"]}},"/partners/{partnerId}/members":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}}],"get":{"summary":"Get Partner Members","description":"Gets a paginated list of details for all members at the `Partner` level.","operationId":"GetPartnerMembers","parameters":[{"description":"Specifies the max number of members to return in the response. This should be a positive integer.","in":"query","name":"limit","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"description":"Specifies the number of members to skip at the start of the response. This should be a positive integer. Combined with limit, this allows for paging through the members found in the search. Don’t include this parameter on the first call. Use the nextOffset value returned in a previous response to request the next page of members.","in":"query","name":"offset","required":false,"schema":{"type":"integer","minimum":0,"default":0,"example":50}}],"responses":{"200":{"description":"Retrieve members at the `Partner` level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedPartnerMembersResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Partners"]},"post":{"summary":"Add Partner Member","description":"Adds a user as a `Partner` level member. Such members will have access to all `Teams` belonging to all `Organizations` belonging to the `Partner`. Members at `Partner` level can only be removed at `Partner` level. The access granted as a Partner Member will supersede any pre-existing access the user had. This includes team and organization access.","operationId":"AddPartnerMember","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberCreationRequest"}}},"description":"Member details","required":true},"responses":{"201":{"description":"Response returned if the `Partner` member is successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerMemberResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Returned if adding a user who already has a membership at the `Partner` level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Partners"]}},"/partners/{partnerId}/members/{userId}":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}},{"name":"userId","in":"path","description":"Signifyd's unique identifier for the user.","required":true,"schema":{"type":"integer","format":"int64","example":123456}}],"post":{"summary":"Update Partner Member","description":"Updates a member at a `Partner` level. Any fields not specified will not be changed.","operationId":"UpdatePartnerMember","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberUpdateRequest"}}},"description":"member details","required":true},"responses":{"200":{"description":"Response returned if the `Partner` member is successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerMemberResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Partners"]},"get":{"summary":"Get Partner Member","description":"Gets the details for a `Partner` member.","operationId":"GetPartnerMember","responses":{"200":{"description":"Retrieve the current state of a `Partner` member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerMemberResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Partners"]},"delete":{"summary":"Remove Partner Member","description":"Removes `Partner` membership from a user. This will remove the ability for that user to access information regarding all `Organizations` and `Teams` that the user is not directly a member of.","operationId":"RemovePartnerMember","responses":{"204":{"description":"Response returned if the `Partner` member is successfully removed."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Partners"]}},"/partners/{partnerId}/organizations":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}}],"post":{"summary":"Create Organization","description":"Creates an `Organization`. This is an entity used to group related `Teams` together for billing purposes. For example, if you have merchants that are mapped to `Teams`, but are billed at a higher entity level you would group them under a single `Organization`. `Teams` must belong to an `Organization` and one must create an `Organization` in order to create `Teams`.","operationId":"CreateOrganization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}},"description":"Organization details","required":true},"responses":{"201":{"description":"Response returned if the Organization is successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Organizations"]}},"/partners/{partnerId}/organizations/{orgId}":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}},{"name":"orgId","in":"path","description":"Signifyd's unique identifier for the Organization","required":true,"schema":{"type":"integer","format":"int64","example":123456}}],"get":{"summary":"Get Organization","description":"Gets the details for an `Organization`","operationId":"GetOrganization","responses":{"200":{"description":"Response returned if the Organization is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Organizations"]},"post":{"summary":"Update Organization","description":"Updates an `Organization`. Any fields not supplied will not be changed.","operationId":"UpdateOrganization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUpdateRequest"}}},"description":"Organization details","required":true},"responses":{"200":{"description":"Response returned if the Organization is successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Organizations"]}},"/partners/{partnerId}/organizations/{orgId}/members":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}},{"name":"orgId","in":"path","description":"Signifyd's unique identifier for the Organization.","required":true,"schema":{"type":"integer","format":"int64","example":123456}}],"get":{"summary":"Get Organization Members","description":"Gets a paginated list of details for all members at the `Organization` level.","operationId":"GetOrganizationMembers","parameters":[{"description":"Specifies the max number of members to return in the response. This should be a positive integer.","in":"query","name":"limit","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"description":"Specifies the number of members to skip at the start of the response. This should be a positive integer. Combined with limit, this allows for paging through the members found in the search. Don’t include this parameter on the first call. Use the nextOffset value returned in a previous response to request the next page of members.","in":"query","name":"offset","required":false,"schema":{"type":"integer","minimum":0,"default":0,"example":50}}],"responses":{"200":{"description":"Retrieve members at the `Organization` level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedOrganizationMembersResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Organizations"]},"post":{"summary":"Add Organization Member","description":"Adds a user as an `Organization` level member. Such members will have access to all `Teams` belonging to that `Organization`. Members at `Organization` level can only be removed at `Organization` level. The access granted as a Organization Member will supersede any pre-existing team access the user had.","operationId":"AddOrganizationMember","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberCreationRequest"}}},"description":"Member details","required":true},"responses":{"201":{"description":"Response returned if the `Organization` member is successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationMemberResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Returned if adding a user who already has a membership at the `Organization` level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Organizations"]}},"/partners/{partnerId}/organizations/{orgId}/members/{userId}":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}},{"name":"orgId","in":"path","description":"Signifyd's unique identifier for the Organization.","required":true,"schema":{"type":"integer","format":"int64","example":123456}},{"name":"userId","in":"path","description":"Signifyd's unique identifier for the user.","required":true,"schema":{"type":"integer","format":"int64","example":123456}}],"post":{"summary":"Update Organization Member","description":"Updates a member at an `Organization` level. Any fields not specified will not be changed.","operationId":"UpdateOrganizatonMember","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberUpdateRequest"}}},"description":"member details","required":true},"responses":{"200":{"description":"Response returned if the `Organization` member is successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationMemberResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Organizations"]},"get":{"summary":"Get Organization Member","description":"Gets the details for an `Organization` member.","operationId":"GetOrganizationMember","responses":{"200":{"description":"Retrieve the current state of an `Organization` member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationMemberResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Organizations"]},"delete":{"summary":"Remove Organization Member","description":"Removes `Organization` membership from a user. This will remove the ability for that user to access information regarding all `Teams` belonging to the `Organization`.","operationId":"RemoveOrganizationMember","responses":{"204":{"description":"Response returned if the `Organization` member is successfully removed."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Organizations"]}},"/partners/{partnerId}/teams":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}}],"post":{"summary":"Create Team","operationId":"CreateTeam","description":"A fundamental unit of the Signifyd API is a `Team`. A single `Team` typically equates to a single merchant. Orders are submitted to Signifyd under that `Team` and users belonging to that `Team` can access those orders in the [Signifyd Console](http://app.signifyd.com). Normally the merchant itself creates and manages its own `Teams`. The Signifyd Partners API is designed to allow `Teams` to be created, updated and associated programatically by a trusted third-party.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}}},"description":"Team details","required":true},"responses":{"201":{"description":"Response returned if the Team is successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]}},"/partners/{partnerId}/teams/{teamId}":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}},{"name":"teamId","in":"path","description":"Signifyd's unique identifier for the Team","required":true,"schema":{"type":"integer","format":"int64","example":789123}}],"get":{"summary":"Get Team","description":"Gets the details for a `Team`","operationId":"GetTeam","responses":{"200":{"description":"Response returned if the Team is successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamFullResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]},"post":{"summary":"Update Team","description":"Updates a `Team`. Any fields not supplied will not be changed. If one wishes to update the status or products of a `Team` one must use the endpoints specifically for that purpose rather than this one. The OrgId which links the `Team` to its `Organization` can not be changed.","operationId":"UpdateTeam","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamUpdateRequest"}}},"description":"Team details","required":true},"responses":{"200":{"description":"Response returned if the Team is successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]}},"/partners/{partnerId}/teams/{teamId}/status/goLive":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}},{"name":"teamId","in":"path","description":"Signifyd's unique identifier for the Team","required":true,"schema":{"type":"integer","format":"int64","example":789123}}],"post":{"summary":"Set Team Live","description":"Change the team status from `BURN_IN` to `LIVE`. For teams created using the Partners API Teams, Signifyd will have to approve internally before this endpoint can work.","operationId":"SetTeamLive","responses":{"200":{"description":"Response returned if the Team status is successfully set to Live.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamStatusOnlyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]}},"/partners/{partnerId}/teams/{teamId}/product":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}},{"name":"teamId","in":"path","description":"Signifyd's unique identifier for the Team","required":true,"schema":{"type":"integer","format":"int64","example":789123}}],"post":{"summary":"Add Team Product","description":"Adds a product to the Team","operationId":"AddTeamProduct","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamProduct"}}},"description":"Adds a product to a Team.","required":true},"responses":{"200":{"description":"Response returned if the product is successfully added to the Team.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamProductOnlyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]}},"/partners/{partnerId}/teams/{teamId}/members":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}},{"name":"teamId","in":"path","description":"Signifyd's unique identifier for the Team.","required":true,"schema":{"type":"integer","format":"int64","example":123456}}],"get":{"summary":"Get Team Members","description":"Gets a paginated list of details for all members at the `Team` level.","operationId":"GetTeamMembers","parameters":[{"description":"Specifies the max number of members to return in the response. This should be a positive integer.","in":"query","name":"limit","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"description":"Specifies the number of members to skip at the start of the response. This should be a positive integer. Combined with limit, this allows for paging through the members found in the search. Don’t include this parameter on the first call. Use the nextOffset value returned in a previous response to request the next page of members.","in":"query","name":"offset","required":false,"schema":{"type":"integer","minimum":0,"default":0,"example":50}}],"responses":{"200":{"description":"Retrieve members at the `Team` level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedTeamMembersResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]},"post":{"summary":"Add Team Member","description":"Adds a user as a `Team` level member.","operationId":"AddTeamMember","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberCreationRequest"}}},"description":"Member details","required":true},"responses":{"201":{"description":"Response returned if the `Team` member is successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamMemberResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"Returned if adding a user who already has a membership at the `Team` level.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]}},"/partners/{partnerId}/teams/{teamId}/members/{userId}":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}},{"name":"teamId","in":"path","description":"Signifyd's unique identifier for the Team.","required":true,"schema":{"type":"integer","format":"int64","example":123456}},{"name":"userId","in":"path","description":"Signifyd's unique identifier for the user.","required":true,"schema":{"type":"integer","format":"int64","example":123456}}],"post":{"summary":"Update Team Member","description":"Updates a member at a `Team` level. Any fields not specified will not be changed.","operationId":"UpdateTeamMember","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberUpdateRequest"}}},"description":"member details","required":true},"responses":{"200":{"description":"Response returned if the `Team` member is successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamMemberResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]},"get":{"summary":"Get Team Member","description":"Gets the details for a `Team` member.","operationId":"GetTeamMember","responses":{"200":{"description":"Retrieve the current state of a `Team` member.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamMemberResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]},"delete":{"summary":"Remove Team Member","description":"Removes `Team` membership from a user.","operationId":"RemoveTeamMember","responses":{"204":{"description":"Response returned if the `Team` member is successfully removed."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Teams"]}},"/partners/{partnerId}/users":{"parameters":[{"name":"partnerId","in":"path","description":"Signifyd's unique identifier for the partner. This can also accept the placeholder \"0\" which will automatically populate with your partnerId using your partner credentials via an API.","required":true,"schema":{"type":"integer","format":"int64","example":123}}],"post":{"summary":"Create User","description":"Creates a `User` with a given email address or finds an already created `User` by the `Partner`. Although the `Partner` owns this `User` and can make any changes they want to the `User`, the `User` will initially not be a member of the `Partner` entities and have no visibility of `Teams`. The `User` can be added as a member at a `Team`, `Organization` or `Partner` level after creation.","operationId":"CreateUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreation"}}},"required":true},"responses":{"200":{"description":"Response returned if the User already exists and is owned by the Partner.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreation"}}}},"201":{"description":"Response returned if the user is successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreation"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Users"]}},"/orders/events/chargebacks":{"post":{"summary":"Create Chargeback","description":"<p>To create a chargeback against an Order in the Signifyd system, you need to record a Chargeback Event.</p>\n<p>Within this call, Signifyd will create a single claim, along with the chargeback. Any fulfillments sent will be created for the order.</p>\n<p>If the chargeback already exists in the Signifyd system, a duplicate chargeback exception will be raised and the chargeback will not be created or updated.</p>\n<p>Multiple different chargebacks can be created against an order, dependent on the Signifyd team settings.</p>\n<p>The response will contain a summary of the current state of the main Chargeback Case artifacts, namely Chargeback, Claim and Representment Summaries. A representment summary will only be returned if an unassigned representment was created.</p>\n<p>According to the Signifyd team settings, an unassigned representment will be created if the team is covered for chargeback recovery or the team has given consent to full access.</p>","operationId":"CreateChargeback","parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargebackRequest"}}},"description":"","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargebackCaseResponse"}}},"description":"Returned when a chargeback has been successfully created.","headers":{}},"204":{"$ref":"#/components/responses/NoContent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"404":{"$ref":"#/components/responses/OrderNotFound"},"409":{"$ref":"#/components/responses/ConflictDuplicateChargeback"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Chargebacks"]}},"/orders/events/chargebacks/representments/outcomes":{"post":{"summary":"Representment Outcome","description":"<p>To set the outcome of a Chargeback's Representment in the Signifyd system, you need to record a Representment Outcome Event.</p>","operationId":"RepresentmentOutcome","parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargebackUpdateOutcomeRequest"}}},"description":"","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargebackCaseResponse"}}},"description":"Returned when a chargeback has been successfully updated.","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"404":{"$ref":"#/components/responses/ChargebackNotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Chargebacks"]}},"/orders/events/chargebacks/stages":{"post":{"summary":"Chargeback Stage","description":"<p>To change the stage of a Chargeback in the Signifyd system, you need to record a Chargeback Stage Event.</p>\n<p>As well as changing the Chargeback stage, this Api allows you to optionally also update the Chargeback Amount, Reason and Representment Outcome.</p>\n<p>This event must change the stage of a Chargeback. If the request contains the existing stage, then the request will be rejected.</p>","operationId":"ChargebackStage","parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargebackUpdateStageRequest"}}},"description":"","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargebackCaseResponse"}}},"description":"Returned when a chargeback has been successfully updated.","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"404":{"$ref":"#/components/responses/ChargebackNotFound"},"409":{"$ref":"#/components/responses/ConflictCurrentStage"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Chargebacks"]}},"/orders/events/chargebacks/earlyalert":{"post":{"summary":"Create Early Alert","description":"<p>To create an early alert against an order in the Signifyd system, you need to record an Early Alert Event.</p>","operationId":"CreateEarlyAlert","parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarlyAlertRequest"}}},"description":"","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarlyAlertResponse"}}},"description":"Returned when an early alert has been successfully created.","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"404":{"$ref":"#/components/responses/OrderNotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Chargebacks"]}},"/orders/events/checkouts":{"post":{"summary":"Checkout","description":"The Checkout endpoint in Signifyd's API is used to record a Checkout Event in a Pre-Auth flow. This call should be made _before_ calling your Payment Gateway. After the Payment Gateway call, you _must_ complete the checkout process with a call to the Transaction endpoint.\n\nIf a previous Checkout Event with the same `orderId` has been received, the Order will be updated and/or overwritten with the new details, except for `purchase.createdAt`, which can be set only once per order. For partial updates, other event types (such as Reprice or Reroute) can be used. Orders can be updated up to 100 times to generate a new decision. Updates beyond the 100th will result in a decision.checkpointAction value of `REJECT`.\n\nThe `orderId` value acts as a primary key and should be consistent across all purchase attempts related to the same order. A consistent `orderId` enables Signifyd to accurately deduplicate purchases and provide reliable performance metrics. If your system cannot provide a consistent `orderId` across multiple purchase attempts, please contact your Signifyd implementations manager to discuss alternative deduplication strategies.\n\nIf Decision Center is enabled, policies for Sale events can be configured at the Sale checkpoint, and they will be applied to orders created via requests to this endpoint.\n","operationId":"Checkout","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checkout"}}},"description":"","required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"200":{"description":"If a past Order has been created in the Signifyd system with the same orderId and checkout as this call, then no updates to the Order will occur.  We will simply return the existing Order details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}},"headers":{}},"201":{"description":"A 201 response is returned when the request resulted in the creation of a new `Order` in the Signifyd system or for a successful update of an existing Order..","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutResponse"}}},"headers":{}},"204":{"$ref":"#/components/responses/NoContent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Purchases"]}},"/orders/events/repricings":{"post":{"summary":"Reprice","description":"The Repricing endpoint allows merchants to update an order's price for changes not initiated by the buyer, such as substituting an out-of-stock product. Repricing does not alter the original decision from Signifyd; for example, FRAUD and INR coverage for $150 would adjust to $100 if the price is updated, and the invoice would reflect the new amount. This endpoint is not for buyer-initiated cart changes, which should be recorded as new Checkout events.\n\nOrders can be updated up to 100 times within 14 days of placement. Updates beyond the 100th return an HTTP 400 response. Special access is required, enabled by your Implementation Manager, and the 14-day window can be extended upon request.\n","operationId":"Reprice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reprice"}}},"description":"","required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepriceResponse"}}},"description":"","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Purchase Management"]}},"/orders/events/transactions":{"post":{"summary":"Transaction","operationId":"Transaction","description":"The Transaction endpoint is used in a PreAuthorization flow where the initial Checkout call to Signifyd occurs before calling your Payment Gateway for authorization. The `checkoutId` and `orderId` indicated in the Transaction request must correspond to identifiers previously received by Signifyd in a successful Checkout call.\n\nAfter authorizing payment through your payment gateway, use this endpoint to provide the complete transaction details. The `transactions` array in this call will fully replace any existing transactions on the Order, so it must include both the data from the Checkout call and any new information obtained during authorization. This marks the transaction as complete unless further events, like voids or refunds, occur (which should be indicated by Record Return event). \n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsRequest"}}},"required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"description":"The Response if the `transactions` were successfully created and replaced the existing `transactions` on the `Order`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionsResponse"}}},"headers":{}},"204":{"$ref":"#/components/responses/NoContent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"Response if the `checkoutId` and the `orderId` cannot be matched to a previously sent `Checkout`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Purchases"]}},"/orders/events/sales":{"post":{"summary":"Sale","description":"The Sale endpoint in Signifyd's API is used to record a Sale Event, which represents the completion of a purchase flow and the associated payment authorization in a **PostAuth** workflow. \n\nUse this endpoint to register an order in the Signifyd system. If an order was previously created using a Checkout or Sale event, calling this endpoint again with the same `orderID` will update and/or overwrite the order details and generate a new decision. The date and time when the order was placed (`purchase.createdAt`) is settable only once per order; if the order already exists, any `purchase.createdAt` sent in this request will not update the stored value.\n\nThe `orderId` value acts as a primary key and should be consistent across all purchase attempts related to the same order. A consistent `orderId` enables Signifyd to accurately deduplicate purchases and provide reliable performance metrics. If your system cannot provide a consistent `orderId` across multiple purchase attempts, please contact your Signifyd implementations manager to discuss alternative deduplication strategies.\n\nIf Decision Center is enabled, policies for Sale events can be configured at the Sale checkpoint, and they will be applied to orders created via requests to this endpoint.\n","operationId":"Sale","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sale"}}},"description":"","required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"description":"A 201 response is returned when the request resulted in the creation of a new Order in the Signifyd system or for a successful update of an existing Order. You will also receive a webhook response if you have webhooks configured.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleResponse"}}},"headers":{}},"204":{"$ref":"#/components/responses/NoContent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Purchases"]}},"/orders/events/reroutes":{"post":{"summary":"Reroute","operationId":"Reroute","description":"Call this endpoint anytime Delivery Address on an Order needs to be changed.  The change will be linked to the original Order with the `orderId` parameter in the body.\n\nOrders can be updated a maximum of 100 times for a new decision. Any updates following the 100th update will  result in an HTTP 400 response.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reroute"}}},"required":true},"parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RerouteResponse"}}},"description":"","headers":{}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Purchase Management"]}},"/orders/{orderId}/decision":{"parameters":[{"name":"orderId","in":"path","required":true,"description":"the unique identifier for an order","schema":{"type":"string"}}],"get":{"summary":"Get Decision","operationId":"GetDecision","description":"Retrieve the latest fraud decision for an order in the Signifyd system.","parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"200":{"description":"Get the latest decision for an Order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDecisionResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Purchases"]}},"/orders/{orderId}/decisions":{"parameters":[{"name":"orderId","in":"path","required":true,"description":"the unique identifier for an order","schema":{"type":"string"}}],"get":{"summary":"Get Decisions","operationId":"GetDecisions","description":"Retrieve the list of decisions associated with an order in the Signifyd system.","parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"responses":{"200":{"description":"Get the current list of decisions for an Order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Decisions"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Purchases"]}},"/orders/events/fulfillments":{"post":{"summary":"Fulfillments","operationId":"Fulfillments","description":"Use this endpoint to record a list of fulfillments associated with an `Order`. All fulfillments passed here will be appended to existing fulfillments. If a fulfillment already exists on the order with any of the provided `shipmentId`s the entire request will be rejected.","parameters":[{"$ref":"#/components/parameters/TeamIdHeader"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Fulfillments"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FulfillmentResponse"}}},"description":"","headers":{}},"204":{"$ref":"#/components/responses/NoContent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"409":{"$ref":"#/components/responses/ConflictWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Purchase Management"]}},"/teams/{teamId}/webhooks":{"x-genTags":["public"],"parameters":[{"name":"teamId","in":"path","description":"Signifyd's unique identifier for the team","required":true,"schema":{"type":"integer","format":"int64","example":567890}}],"post":{"summary":"Create Webhook","description":"Create a new webhook. This will add to the list of any existing webhooks.\n<br> The webhook endpoint must use SSL with either TLSv1.2 or TLSv1.3 protocols.\n<br>Cipher Suites currently supported are:\n<ul>\n    <li>TLS_AES_128_GCM_SHA256</li>\n    <li>TLS_AES_256_GCM_SHA384</li>\n    <li>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</li>\n    <li>TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256</li>\n    <li>TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</li>\n    <li>TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384</li>\n    <li>TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384</li>\n    <li>TLS_DHE_RSA_WITH_AES_256_GCM_SHA384</li>\n    <li>TLS_DHE_DSS_WITH_AES_256_GCM_SHA384</li>\n    <li>TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256</li>\n    <li>TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA25</li>\n    <li>TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256</li>\n    <li>TLS_DHE_RSA_WITH_AES_128_GCM_SHA256</li>\n    <li>TLS_DHE_DSS_WITH_AES_128_GCM_SHA256</li>\n</ul>\n<br> NOTE: You can create more than one webhook per topic.\n","operationId":"CreateTeamWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest"}}}},"responses":{"201":{"description":"Response returned if the webhook is successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Webhook Management"]},"get":{"summary":"Get Webhooks","description":"Get the list of webhooks for a team.  If the user belongs to the team with the given `teamId` or has sufficient privileges to access the team webhooks, a list of webhooks for that team will be returned.\n","operationId":"GetTeamWebhooks","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookArrayResponse"}}},"description":""},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Webhook Management"]}},"/teams/webhooks":{"x-genTags":["public"],"post":{"summary":"Get Webhooks By Version","description":"Get the list of webhooks for a team for a specific API version - V2, V3 or ALL.   The user can supply a list of team IDs and will receive a list of webhooks for each team they have access to. If the user supplies an empty list of team IDs, the user will receive a list of webhooks for all teams the user has access to.\n","operationId":"GetTeamsWebhooksByVersion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhookRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionedWebhookResponse"}}},"description":""},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Webhook Management"]}},"/teams/{teamId}/webhooks/{hookId}":{"x-genTags":["public"],"parameters":[{"name":"teamId","in":"path","description":"Signifyd's unique identifier for the team","required":true,"schema":{"type":"integer","format":"int64","example":567890}},{"name":"hookId","in":"path","description":"Signifyd's unique identifier for the webhook.","required":true,"schema":{"type":"string","example":"00071eb8-468c-4176-b7cc-dc2876ee6b4f"}}],"post":{"summary":"Update Webhook","description":"Replaces an existing webhook identified by the `hookId`.\n","operationId":"UpdateWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Response returned if the webhook is successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Webhook Management"]},"delete":{"summary":"Delete Webhook","description":"Deletes an existing webhook identified by the `hookId`.\n","operationId":"DeleteWebhook","responses":{"204":{"description":"Response returned if the webhook is successfully deleted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Webhook Management"]}},"/webhooks/tests":{"x-genTags":["public"],"post":{"summary":"Test Webhook","description":"Tests that a webhook can be called and responds successfully.","operationId":"TestWebhook","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}},"required":true},"responses":{"200":{"description":"Response returned if the webhooks are successful."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/UnauthorizedWithErrorDetails"},"403":{"$ref":"#/components/responses/ForbiddenWithErrorDetails"},"404":{"$ref":"#/components/responses/NotFoundWithErrorDetails"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Webhook Management"]}},"/sessionIntelligence/{sessionId}":{"post":{"summary":"Session Intelligence","description":"Use this endpoint to retrieve the latest device, browser, and navigation intelligence Signifyd has profiled for a session through the Signifyd web script or mobile SDK.\n\nThe `sessionId` path parameter must exactly match the opaque session identifier passed during profiling.\n\nThe optional request body can include the client IP address and user agent observed by your backend. All request body fields are optional, and the body can be omitted.\n\nA valid session that is unknown, not yet profiled, or no longer available returns HTTP 200 with `profileStatus: NOT_PROFILED` and `device: null`. This is not an error response.\n\nSession data remains available for approximately 24 hours.\n\nAccess to this API is restricted. Contact your Signifyd customer support representative to request access.","operationId":"GetSessionIntelligence","parameters":[{"name":"sessionId","in":"path","required":true,"description":"The session identifier (10-256 characters, no control characters) must exactly match the opaque string passed to the OAK web script or mobile SDK during profiling.","schema":{"type":"string","minLength":10,"maxLength":256}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionIntelligenceRequest"}}},"description":"Optional server-observed device hints."},"responses":{"200":{"description":"Device intelligence for the session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionIntelligenceResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/ServerError"}},"tags":["Session Intelligence"]}}},"x-webhooks":{"onOrderCheckpointActionUpdate":{"post":{"summary":"Order Checkpoint Action Update","security":[],"parameters":[{"in":"header","name":"SIGNIFYD-TOPIC","schema":{"$ref":"#/components/schemas/WebhookTopic"},"required":true},{"in":"header","name":"SIGNIFYD-CHECKPOINT","schema":{"$ref":"#/components/schemas/Checkpoint"},"required":true},{"in":"header","name":"SIGNIFYD-SEC-HMAC-SHA256","schema":{"type":"string","description":"To allow a client to verify a webhook message has in fact come from SIGNIFYD, an `SIGNIFYD-SEC-HMAC-SHA256` header is included in each webhook POST message. The contents of this header is the Base64 encoded output of the HMAC SHA256 encoding of the JSON body of the message, using the team's API key as the encryption key.\n"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCallback"}}}},"responses":{"2XX":{"description":"To acknowledge receipt of a webhook, your endpoint should be publicly accessible and return a 2xx HTTP status code. All response codes outside this range, including 3xx codes, will indicate to Signifyd that you did not receive the webhook.\n"},"default":{"description":"If your endpoint does not successfully receive a webhook we will resend the webhook up to 15 times over four days. The first webhook will be retried after 20s with exponential delays for each subsequent retry.\n"}},"tags":["Webhook Events"]}}},"components":{"securitySchemes":{"Server-Side-Auth":{"description":"All server-side API requests must be made over HTTPS using a [base64 encoded](https://en.wikipedia.org/wiki/Base64) API key. You can generate an API key by creating a team in [settings](https://app.signifyd.com/settings) page.\n\n- Authentication: [HTTP Basic Auth](http://en.wikipedia.org/wiki/Basic_access_authentication#Client_side). - Username: Your API key as the basic auth username. - Password: You do not need to provide a password. However, some REST clients expect a username:password pair separated by a colon. If so, you can use a colon as the password.\n","type":"http","scheme":"basic"}},"schemas":{"OrderId":{"type":"string","description":"Unique identifier for the order.","example":"XGR-1840823423"},"ReturnPolicy":{"description":"This field specifies how the decision returned in the `decision` field will be made.  \n  * `EVALUATE` - Specifies that the return request requires an evaluation, generating a response with a score/decision.\n  * `INFO_ONLY` - Designates an informational return request that does not require evaluation.\n","type":"string","enum":["EVALUATE","INFO_ONLY"],"default":"EVALUATE","example":"EVALUATE"},"ReturnId":{"type":"string","description":"Unique identifier for the Return.","example":"e4056107-6720-431f-a9f4-fe0ff9b6c92a"},"ReturnDate":{"type":"string","format":"date-time","description":"The time the return occurred. If this field is empty the present time is used instead.","example":"2021-09-30T15:30:00+01:00"},"ClientIpAddress":{"description":"`needed` The IP Address of the device or browser. You must provide a valid IP address syntax. Do not provide local  host IP or CDN IP information. Fraud decisioning and the guarantee require end client IP information.","type":"string","x-sig-needed":true,"example":"75.100.88.78"},"SessionId":{"description":"`needed` The unique id for the user's session. This must be the same as the identifier provided by your implementation of Signifyd's device fingerprinting.","type":"string","x-sig-needed":true,"example":"82ce5fca-c2b2-429b-b487-6c3053469f85"},"DeviceFingerprint":{"type":"object","description":"A device fingerprinting payload you supply to Signifyd for use in decisioning.  Some integrations with Signifyd perform device profiling before this API call and provide the profiling payload here.  Standard Signifyd integrations do not need to provide this field. For more information on device fingerprinting, please see this <a href=\"https://docs.signifyd.com/#section/Device-Fingerprinting\">link</a>.","required":["provider","payload"],"properties":{"provider":{"description":"The name of the device fingerprint provider (threatmetrix, inauth, iovation).","type":"string","example":"threatmetrix"},"payload":{"type":"string","description":"Base64 encoding of the device fingerprint response given by the provider.","example":"aSBnZXQgYnkgd2l0aCBhIGxpdHRsZSBoZWxwIGZyb20gbXkgZnJpZW5kcw=="},"payloadEncoding":{"description":"The character encoding of the payload, e.g. UTF8 or ASCII.","type":"string","enum":["UTF8","ASCII"]},"payloadVersion":{"type":"string","description":"The version number for the payload's structure/schema, if the provider has given one. This is used to identify changes in response structure when a provider introduces changes to their API.","nullable":true}}},"Device":{"title":"Device","description":"Data about the device that was used by the user to complete the actions.","type":"object","properties":{"clientIpAddress":{"$ref":"#/components/schemas/ClientIpAddress"},"sessionId":{"$ref":"#/components/schemas/SessionId"},"fingerprint":{"$ref":"#/components/schemas/DeviceFingerprint"}}},"ReturnReason":{"description":"The reason that the buyer is making this return for the item:\n  * `BETTER_PRICE_AVAILABLE` - The buyer found a better price for the item.\n  * `BOUGHT_BY_MISTAKE` - The buyer unintentionally bought some item in the order.\n  * `CANCELATION` - This item was canceled before shipment and the funds will be refunded or released to the buyer.\n  * `CANCELLED_BY_ISSUER` - The item was canceled by the merchant and the funds will be refunded or released to the buyer.\n  * `DID_NOT_AUTHORIZE` - The buyer did not authorize the transaction.\n  * `DUPLICATE_ORDER` - The buyer unintentionally placed a duplicate order.\n  * `ITEM_ARRIVED_TOO_LATE` - The item did not arrive on time.\n  * `ITEM_NOT_RECEIVED` - The buyer never received the item.\n  * `NO_LONGER_NEEDED` - The item has been received but buyer does not need the item anymore.\n  * `ITEM_DAMAGED` - The buyer claims the item arrived damaged.\n  * `SIGNIFICANTLY_NOT_AS_DESCRIBED` - The item received is significantly different from what was described or expected.\n  * `ORDER_ERROR` - The item is being returned due to an error with the order.\n  * `LOST` - The package has been lost.\n  * `OTHER` - The return or refund is for a reason not listed above.","type":"string","enum":["BETTER_PRICE_AVAILABLE","BOUGHT_BY_MISTAKE","CANCELATION","CANCELLED_BY_ISSUER","DID_NOT_AUTHORIZE","DUPLICATE_ORDER","ITEM_ARRIVED_TOO_LATE","ITEM_NOT_RECEIVED","NO_LONGER_NEEDED","ITEM_DAMAGED","SIGNIFICANTLY_NOT_AS_DESCRIBED","ORDER_ERROR","LOST","OTHER"]},"ReturnSubReason":{"description":"Further information on the reason that the buyer is making this return for the item. SubReasons should only be used alongside the relevant primary reason as laid out below:\nITEM_NOT_RECEIVED:\n  * PACKAGE_NOT_RECEIVED - There is a carrier scan of delivery but customer claims INR\n  * ITEM_MISSING_FROM_RECEIVED_PACKAGE - Package received but item missing.\n\nSIGNIFICANTLY_NOT_AS_DESCRIBED:\n  * LARGER_THAN_EXPECTED - The item received is larger or longer than buyer expected.\n  * SMALLER_THAN_EXPECTED - The item received is smaller or shorter than buyer expected.\n  * WRONG_FIT - The item received does not fit well enough.\n  * WRONG_COLOR - The item received does not have the expected color.\n  * WRONG_SIZE - The item received came on a different size than ordered.\n  * QUALITY_ISSUE - The item received has a quality issue.\n\nORDER_ERROR:\n  * NOT_DELIVERABLE - The item was not delivered due to some deliverability issue on the order.\n  * NOT_ORDERED - The item received was not ordered. \n\nLOST:\n  * PACKAGE_NOT_RECEIVED - Package was lost by carrier on the way to the buyer.\n  * RETURN_NOT_RECEIVED - The returned item was not received by the Distribution Center.\n  * MISSORT - Item never left the Distribution Center.\n  * NOT_DELIVERABLE - There was a failed attempt of delivery by the carrier and now the package is lost.\n\nOTHER:\n  * WAIVE_SHIPPING_FEE - Refund for a request to waive shipping fee.\n  * RETURN_RECEIVED_NO_REFUND_ISSUED - Refund for a return received and verified.\n  * RETURN_IN_STORE_NO_REFUND_ISSUED - Refund for a return in store and verified.\n  * UPSET_CUSTOMER - Refund to be issued to an upset customer. \n\nCANCELATION:\n  * BANK_ALERTED_FRAUD: Canceled by merchant due to early fraud notification/alerting.\n  * INTERNAL_IDENTIFIED_FRAUD: Canceled by merchant due to suspected fraud by internal analysts/systems.\n  * CUSTOMER_REPORTED_FRAUD: Canceled by merchant due to direct notification from customer of fraud.\n  * CANCELED_BY_USER: Canceled by user.","type":"string","enum":["PACKAGE_NOT_RECEIVED","ITEM_MISSING_FROM_RECEIVED_PACKAGE","LARGER_THAN_EXPECTED","SMALLER_THAN_EXPECTED","WRONG_FIT","WRONG_COLOR","WRONG_SIZE","QUALITY_ISSUE","NOT_DELIVERABLE","NOT_ORDERED","RETURN_NOT_RECEIVED","MISSORT","WAIVE_SHIPPING_FEE","RETURN_RECEIVED_NO_REFUND_ISSUED","RETURN_IN_STORE_NO_REFUND_ISSUED","UPSET_CUSTOMER","BANK_ALERTED_FRAUD","INTERNAL_IDENTIFIED_FRAUD","CUSTOMER_REPORTED_FRAUD","CANCELED_BY_USER"]},"Price":{"type":"number","format":"double","minimum":0,"example":9.99},"Quantity":{"type":"number","format":"double","example":1},"Subscription":{"title":"Subscription","description":"If this product is being delivered as part of a subscription, then you can include these fields to include data about the subscription itself. The entire `itemQuantity` on this `product` should be purchased via the subscription.  If the buyer added extra items of the same product, those should be listed in separate product line item.","type":"object","required":["periodUnit"],"properties":{"subscriptionId":{"description":"`needed`A unique identifier for the subscription itself.  There can be many products associated with a single `subscriptionId`.","type":"string","example":"97c56c86-7984-44fa-9a3e-7d5f34d1bead"},"nextDeliveryDate":{"type":"string","format":"date","description":"The expected delivery date, following this one, formatted as yyyy-MM-dd.","example":"2022-01-22"},"periodUnit":{"description":"Frequency of the given subscription. Only passing one value in the array is currently supported. Passing more than one value will result in a 4xx error response.","type":"array","items":{"type":"string","enum":["DAY","WEEK","MONTH","QUARTER","YEAR"],"example":"MONTH"},"minItems":1,"maxItems":1},"totalPeriods":{"description":"Total subscription term expressed as a number of `periodUnits`. If the subscription does not have a defined end, then do not include this field.","type":"integer","format":"int32","example":12},"regularItemPrice":{"description":"What the product's price would be if it was purchased as a one-time purchase, rather than as a subscription.","format":"double","type":"number","example":49.99},"currentPeriod":{"description":"The current subscription period that the recurring order belongs to (1st month, 3rd quarter, etc.).","type":"integer","format":"int32","example":1}}},"IdentityDocument":{"title":"IdentityDocument","type":"object","properties":{"identityDocumentType":{"description":"The type of the identity document.\n  * `PASSPORT` - Passport of the passenger.\n  * `DRIVERS_LICENSE` - Driver's license of the passenger.\n  * `PERMANENT_RESIDENT_CARD` - Permanent resident card of the passenger.\n","type":"string","enum":["PASSPORT","DRIVERS_LICENSE","PERMANENT_RESIDENT_CARD"],"example":"PASSPORT"},"issuanceGeo":{"description":"Issuance geo, state/province/country.","type":"string","example":"US"},"last4":{"description":"Last 4 characters of document ID (passport number, etc.).","type":"string","example":"1234"},"issuanceDate":{"type":"string","format":"date","description":"Issuance date for the IdentityDocument.","example":"2015-01-02"},"expiryDate":{"type":"string","format":"date","description":"Expiration date for the IdentityDocument.","example":"2025-01-01"}}},"Currency":{"type":"string","format":"ISO-4217-Alpha","minLength":3,"maxLength":3,"example":"USD"},"AncillaryPurchase":{"title":"AncillaryPurchase","type":"object","properties":{"ancillaryPurchaseType":{"description":"The type for the ancillary purchase.\n  * `MEAL` - Purchase for in-flight meal.\n  * `BAGGAGE` - Purchase for checked bags.\n  * `TRAVEL_INSURANCE` - Purchase for travel insurance.\n  * `ENTERTAINMENT` - Purchase for in-flight entertainment.\n  * `SEAT` - Purchase for in-flight seat.\n  * `CARBON_OFFSET` - Purchase for carbon offsetting the flight.\n  * `ANCILLARY` - Generic type, used for V2 travel mapping.\n","type":"string","enum":["MEAL","BAGGAGE","TRAVEL_INSURANCE","ENTERTAINMENT","SEAT","CARBON_OFFSET","ANCILLARY"],"example":"MEAL"},"itemName":{"description":"Item name for the ancillary purchase.","type":"string","example":"meal"},"itemPrice":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"The price paid for each item (not the aggregate).","example":25.99,"type":"number"}]},"itemQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"},{"description":"The quantity of this item.","example":1,"type":"number"}]},"currency":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"The currency in which the `itemPrice` and all other amounts are denominated. If omitted, the currency is assumed to be USD.","example":"USD","type":"string"}]}}},"Passenger":{"required":["passengerId"],"title":"Passenger","type":"object","properties":{"passengerId":{"description":"Unique identifier for the passenger.","type":"string","example":"48152066-f73b-11ec-b939-0242ac120002"},"firstName":{"description":"First name of the passenger.","type":"string","example":"Bob"},"lastName":{"description":"Last name of the passenger.","type":"string","example":"Smith"},"dateOfBirth":{"type":"string","format":"date","description":"The date of birth.","example":"1985-01-02"},"email":{"description":"The email for the passenger.","type":"string","format":"email","example":"bob@example.com"},"phone":{"description":"The phone number associated with the passenger.","type":"string","example":"+442071838750"},"membershipLast4":{"description":"The last four digits of the membership ID.","type":"string","example":"1234"},"identityDocument":{"description":"The identity document for the passenger","allOf":[{"$ref":"#/components/schemas/IdentityDocument"}]},"ticketStatus":{"description":"The status of the passenger's ticket.\n  * `PURCHASED` - Ticket has been purchased but not fulfilled / delivered.\n  * `TICKETED` - Ticket issued to the passenger.\n  * `CANCELED_BY_USER` - Ticket was canceled by user.\n  * `CANCELED_BY_ISSUER` - Ticket was canceled by airline.\n  * `REFUNDED` - A refund was issued for the ticket.\n  * `NO_SHOW` - An active ticket was not used to board a flight that has already departed.\n  * `USED` - Ticket was used to board a flight.\n","type":"string","enum":["PURCHASED","TICKETED","CANCELED_BY_USER","CANCELED_BY_ISSUER","REFUNDED","NO_SHOW","USED"],"example":"TICKETED"},"ancillaryPurchases":{"description":"A list of ancillary purchases associated with the passenger.","items":{"$ref":"#/components/schemas/AncillaryPurchase"},"type":"array"}}},"DateTime":{"description":"Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).","type":"string","format":"date-time"},"Leg":{"title":"Leg","type":"object","properties":{"routeCode":{"description":"The flight number of the airline leg.","type":"string","example":"UA2604"},"departureCity":{"description":"The departure city of this airline leg.","type":"string","example":"Chicago"},"departureState":{"description":"The departure state or province of this airline leg.","type":"string","example":"Illinois"},"departureCountryCode":{"description":"The departure country code of this airline leg.","type":"string","example":"US"},"departurePortCode":{"description":"The departure portal code of this airline leg.","type":"string","example":"ORD"},"arrivalCity":{"description":"The arrival city of this airline leg.","type":"string","example":"Detroit"},"arrivalState":{"description":"The arrival state or province of this airline leg.","type":"string","example":"Michigan"},"arrivalCountryCode":{"description":"The arrival country code of this airline leg.","type":"string","example":"US"},"arrivalPortCode":{"description":"The arrival portal code of this airline leg.","type":"string","example":"DTW"},"departureDatetime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"description":"The departure date time.","example":"2020-12-25T08:01:00-0700","type":"string"}]},"arrivalDatetime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"description":"The arrival date time.","example":"2020-12-25T09:31:00-0700","type":"string"}]},"carrierName":{"description":"The carrier name.","type":"string","example":"United Airline"}}},"Slice":{"title":"Slice","type":"object","properties":{"slicePrice":{"description":"The total amount of this slice.","example":105.99,"allOf":[{"$ref":"#/components/schemas/Price"}]},"currency":{"description":"The currency in which the `slicePrice` is denominated. If omitted, the currency is assumed to be USD.","example":"USD","allOf":[{"$ref":"#/components/schemas/Currency"}]},"legs":{"description":"Legs of the slice, recommanded to be ordered by the earliest departure time, ascendingly.","items":{"$ref":"#/components/schemas/Leg"},"type":"array"},"bookingClass":{"description":"Booking class for the ticket.\n  * `ECONOMY` - Ticket for economy class.\n  * `PREMIUM_ECONOMY` - Ticket for premium economy class.\n  * `BUSINESS` - Ticket for business class.\n  * `FIRST_CLASS` - Ticket for first class.\n","type":"string","enum":["ECONOMY","PREMIUM_ECONOMY","BUSINESS","FIRST_CLASS"],"example":"FIRST_CLASS"}}},"AirlineTripDetail":{"required":["slice"],"title":"AirlineTripDetail","type":"object","properties":{"slice":{"description":"Slice of the ticket, includes slice price, travel legs and other info.","allOf":[{"$ref":"#/components/schemas/Slice"}]},"isFlexible":{"description":"Indicates whether the airline trip is flexible to cancel. If not provided, defaults to false.","type":"boolean","example":false},"isInsured":{"description":"Indicates whether the airline trip is insured. If not provided, defaults to false.","type":"boolean","example":false},"ifMilesUsed":{"description":"Indicates whether the mileage is used. If not provided, defaults to false.","type":"boolean","example":false},"numOfMilesUsed":{"description":"Indicates the number of mileage used. If not provided, defaults to 0.","type":"integer","example":10000},"milesBalance":{"description":"Indicates the mileage balance. If not provided, defaults to 0.","type":"integer","example":30000},"milesOriginCompanyName":{"description":"Indicates the miles origin company name.","type":"string","example":"United Airline Mileage Plus"},"ifPartnerMilesUsed":{"description":"Indicates whether the partner mileage is used. If not provided, defaults to false.","type":"boolean","example":false}}},"Travel":{"description":"This object is deprecated and will be removed in future releases. Please use `TravelProduct` instead.","required":["passengers"],"title":"Travel","type":"object","properties":{"transportMethod":{"description":"Transport method for the travel.\n  * `AIRLINE` - Traveling by airline.\n  * `BUS` - Traveling by bus.\n  * `SHIP` - Traveling by ship.\n  * `RAIL` - Traveling by rail.\n","type":"string","enum":["AIRLINE","BUS","SHIP","RAIL"],"example":"AIRLINE"},"passengers":{"description":"A list of the passengers in this travel.","items":{"$ref":"#/components/schemas/Passenger"},"type":"array"},"airlineTripDetail":{"description":"Trip level detail specifically for the airline ticket.","allOf":[{"$ref":"#/components/schemas/AirlineTripDetail"}]}}},"Product":{"title":"Product","type":"object","properties":{"itemName":{"description":"`required` The name of the product.","type":"string","example":"Sparkly Sandals"},"itemPrice":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"`required` The price paid for each item (not the aggregate).","example":25.99,"type":"number"}]},"itemQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"},{"description":"`required` The quantity of this item.","example":4,"type":"number"}]},"itemIsDigital":{"description":"`needed` Indicates whether the item is electronically delivered e.g. gift cards.  If not provided, defaults to false.","type":"boolean","x-sig-needed":true,"example":false},"itemCategory":{"description":"`needed` The name of the top-level product category. e.g. Apparel","type":"string","x-sig-needed":true,"example":"Apparel"},"itemSubCategory":{"description":"`needed` The name of the sub-category of the product if applicable. e.g. T-Shirt","type":"string","x-sig-needed":true,"example":"Footwear"},"itemId":{"description":"`needed` Your unique identifier for the product.","type":"string","x-sig-needed":true,"example":"sparkly-sandals-xl-yellow-2020"},"itemImage":{"description":"The url to an image of the product.","type":"string","example":"https://mystore.com/images/54205a06cecb905fb424479-large.jpg"},"itemUrl":{"description":"The url to the product's page on your site.","type":"string","example":"https://mystore.com/54205a06cecb905fb424479-large"},"itemWeight":{"description":"The weight of each item in grams.","type":"number","format":"double","example":200.12},"shipmentId":{"description":"The item's shipment id.","type":"string","example":"4JLHENj6OY56D9BTcQcR"},"subscription":{"$ref":"#/components/schemas/Subscription"},"travel":{"description":"Travel field used to pass in travel information. Travel object is deprecated and will be removed in future releases. Please use `TravelProduct` instead.","allOf":[{"$ref":"#/components/schemas/Travel"}],"deprecated":true},"giftMessage":{"description":"Personalized message included with the gift order.","type":"string","example":"Happy Birthday! Enjoy your gift."},"registryId":{"description":"Identifier linking the order to a specific gift registry.","type":"string","example":"12345"}}},"ReturnProduct":{"required":["reason"],"allOf":[{"properties":{"reason":{"$ref":"#/components/schemas/ReturnReason"},"subReason":{"$ref":"#/components/schemas/ReturnSubReason"}}},{"$ref":"#/components/schemas/Product"}]},"Address":{"title":"Address","type":"object","properties":{"streetAddress":{"description":"`needed` The street number and street name.","type":"string","x-sig-needed":true,"nullable":true,"example":"31 Sherwood Gardens"},"unit":{"description":"The unit or apartment number.","type":"string","nullable":true},"postalCode":{"description":"`needed` The postal code.","type":"string","x-sig-needed":true,"nullable":true,"example":"E14 9WN"},"city":{"description":"`needed` The city name.","type":"string","x-sig-needed":true,"nullable":true,"example":"London"},"provinceCode":{"description":"`needed` The code or abbreviation for the province. In the United States, provide the state's two letter code.","type":"string","x-sig-needed":true,"nullable":true},"countryCode":{"description":"`needed` The two-letter ISO-3166 country code.","type":"string","x-sig-needed":true,"format":"ISO-3166-1-alpha-2","nullable":true,"minLength":2,"maxLength":2,"example":"GB"}}},"Recipient":{"title":"Recipient","type":"object","properties":{"fullName":{"description":"The full name of the person receiving the goods. If this item is being shipped, then this field is the person it is being shipping to. Don't assume this name is the same as `cardHolderName`. Only put a value here if the name will actually appear on the shipping label.","type":"string","example":"Bob Smith"},"organization":{"description":"If provided by the buyer, the name of the recipient's company or organization.","type":"string","example":"Initrode plc"},"email":{"description":"Email address where the goods are being delivered. Only use for digital goods delivered to an email.","type":"string","format":"email","nullable":true,"example":null},"phone":{"description":"Phone number where the goods are being delivered. Only use for digital goods delivered to a phone number.","type":"string","nullable":true,"example":null},"address":{"description":"The location where the goods are being shipped.  Required if these are not digital goods.","allOf":[{"$ref":"#/components/schemas/Address"}]}}},"FulfillmentMethodEnum":{"description":"`needed` Specifies the fulfillment method for the shipment. This field is intended for physical goods shipments. Do not include this field when shipping digital goods or when `destination.email` or `destination.phone` are provided. Signifyd will reject requests that violate these constraints. \nIf your fulfillment method is not available in the provided enumerations, please contact Signifyd Implementations for assistance in adding it.\n","x-sig-description":"`needed` Fulfillment method for the shipment. This should not be used in conjunction with EmailDestination. If the enumerations given don't match your use case, reach out to our Implementations team for assistance in getting one added.  We would rather provide you with a new enumeration than you force-fit into an existing one.","type":"string","enum":["DELIVERY","COUNTER_PICKUP","CURBSIDE_PICKUP","LOCKER_PICKUP","STANDARD_SHIPPING","EXPEDITED_SHIPPING","GAS_PICKUP","SCHEDULED_DELIVERY","TWO_DAY_SHIPPING","OVERNIGHT_SHIPPING","FREIGHT_SHIPPING","SAME_DAY_DELIVERY","SERVICE"],"example":"DELIVERY","x-sig-needed":true},"Shipment":{"title":"Shipment","type":"object","required":["destination"],"properties":{"destination":{"description":"Information about the person and location where the goods are being shipped.","$ref":"#/components/schemas/Recipient"},"origin":{"description":"Information about the location from which the shipment originated.","title":"Origin","type":"object","properties":{"locationId":{"description":"Merchant's internal unique identifier for the location, such as a store or a fulfillment center.","type":"string","example":"boise-store-24"},"address":{"$ref":"#/components/schemas/Address"}}},"carrier":{"type":"string","description":"The name of the Shipper.  Any name will be accepted, but we strongly recommend mapping to one of the following keys if possible:\n  * `FEDEX`\n  * `DHL`\n  * `SHIPWIRE`\n  * `USPS`\n  * `UPS`\n  * `SELLER`","example":"UPS"},"minDeliveryDate":{"description":"The minimum estimated arrival date when the `products` will arrive at the `destination`. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-25T13:57:40-07:00","type":"string","format":"date-time"},"maxDeliveryDate":{"description":"The maximum estimated arrival date when the `products` will arrive at the `destination`. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-28T13:57:40-07:00","type":"string","format":"date-time"},"shipmentId":{"description":"Id for the shipment.","type":"string","example":"4JLHENj6OY56D9BTcQcR"},"fulfillmentMethod":{"$ref":"#/components/schemas/FulfillmentMethodEnum"}}},"ReplacementItems":{"type":"object","properties":{"products":{"description":"A list of products that will be shipped to the buyer as replacements.","items":{"$ref":"#/components/schemas/Product"},"type":"array"},"shipments":{"description":"Details about the delivery destinations and the products for each one.","type":"array","items":{"$ref":"#/components/schemas/Shipment"}}}},"AttemptReturnRefund":{"type":"object","description":"Details about the reimbursement that will be issued to the buyer if the return is approved.","required":["amount"],"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"The total amount of the refund that you are going to give back to the buyer. This amount may not exceed the original price in the Checkout or Sale call.","example":105.99,"type":"number"}],"minimum":0},"currency":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"The currency in which the `amount` is denominated. If not included, we assume the same currency as the original purchase."}]},"method":{"description":"The method by which the refund will be issued:\n  * `STORE_CREDIT` - The refund will be issued in store credits to the buyer's account.\n  * `ORIGINAL_PAYMENT_INSTRUMENT` - The refund will be issued through the original payment instrument of the order.\n  * `NEW_PAYMENT_INSTRUMENT` - The refund will be issued through a new payment instrument provided by the buyer.\n  * `INSTANT_EXCHANGE` - The refund will be issued through an instant exchange of the item(s).","type":"string","enum":["STORE_CREDIT","ORIGINAL_PAYMENT_INSTRUMENT","NEW_PAYMENT_INSTRUMENT","INSTANT_EXCHANGE"]}}},"ReturnInitiator":{"description":"Unique identifier for who initiated the return. This will be used if an internal employee initiated the return.","title":"ReturnInitiator","properties":{"employeeEmail":{"type":"string","description":"Unique email address associated with who initiated the return. Either `employeeEmail` or `employeeId` must be present.","example":"bob@example.com"},"employeeId":{"type":"string","description":"Unique identifier associated with who initiated the return. Either employeeEmail or employeeId must be present.","example":"0001234"}}},"ReturnBase":{"title":"ReturnBase","required":["returnId"],"properties":{"returnId":{"$ref":"#/components/schemas/ReturnId"},"returnDate":{"$ref":"#/components/schemas/ReturnDate"},"device":{"$ref":"#/components/schemas/Device"},"returnedItems":{"description":"A list of products that are going to be returned by the buyer.","items":{"$ref":"#/components/schemas/ReturnProduct"},"type":"array"},"replacementItems":{"$ref":"#/components/schemas/ReplacementItems"},"refund":{"$ref":"#/components/schemas/AttemptReturnRefund"},"initiator":{"$ref":"#/components/schemas/ReturnInitiator"},"tags":{"description":"A list of attributes or short descriptors associated with the return.","type":"array","items":{"type":"string","example":"electronics"}}}},"AttemptReturn":{"title":"AttemptReturn","allOf":[{"type":"object","required":["orderId"],"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"returnPolicy":{"$ref":"#/components/schemas/ReturnPolicy"}}},{"$ref":"#/components/schemas/ReturnBase"}]},"CheckpointAction":{"description":"The suggested action that should be taken for the event.\n* `ACCEPT` - Allow the event to be processed, e.g. Allow the Checkout to Proceed.\n* `ALLOW` - Specific to Account Integrity events. Allow the event to be processed, e.g. allow the user to Login.\n* `CHALLENGE` - Present the user with a Challenge, such as additional authentication, before they are allowed to proceed.\n* `STEP_UP` - Present the User with a Step-up, such as confirmation via OTP, before they are allowed to proceed.\n* `FLAG` - Specific to Account Integrity events. Flag the event for manual review while allowing it to proceed.\n* `ALERT` - Specific to Account Integrity events. Generate an alert for suspicious activity while allowing the event to proceed.\n* `CREDIT` - Specific to refund and return events. Recommend issuing a customer store credit instead of a refund on the original form\n  of payment.\n* `HOLD` - Suspend the event from being processed. e.g. hold the order for a manual review.\n* `REJECT` - Block the event from being processed further. e.g. Cancel the order.\n* `DENY` - Specific to Account Integrity events. Block the event from being processed further.\n","type":"string","enum":["ACCEPT","ALLOW","CHALLENGE","STEP_UP","ALERT","FLAG","CREDIT","HOLD","REJECT","DENY"],"example":"ACCEPT"},"Policy":{"type":"object","title":"Policy","required":["name","status","action","reason"],"properties":{"name":{"description":"Name of the policy.","type":"string","example":"APPROVE_POWER_BUYERS"},"status":{"description":"The result of the policy. * `EVALUATED_TRUE` - The policy was evaluated and its conditions were met so its Action was used. * `EVALUATED_FALSE` - The policy was evaluated and its conditions were not met so its Action was not used. * `SKIPPED` - The policy was not evaluated.\n","type":"string","enum":["EVALUATED_TRUE","EVALUATED_FALSE","SKIPPED"],"example":"EVALUATED_TRUE"},"action":{"$ref":"#/components/schemas/CheckpointAction"},"reason":{"description":"The reason for the suggested action.","type":"string","example":"Power buyer on approve list"}}},"Policies":{"type":"object","nullable":true,"description":"Policies configured at the Checkpoint in Decision Center.","required":["default","overriding"],"properties":{"default":{"description":"The default policy configured at the Checkpoint in Decision Center.","$ref":"#/components/schemas/Policy"},"overriding":{"description":"The overriding policies configured at the Checkpoint in Decision Center.","items":{"$ref":"#/components/schemas/Policy"},"type":"array"}},"example":{"default":{"name":"SIGNIFYD_DECISION","status":"EVALUATED_TRUE","action":"REJECT","reason":"Suspicious user profile"},"overriding":[{"name":"APPROVE_POWER_BUYERS","status":"EVALUATED_TRUE","action":"ACCEPT","reason":"Power buyer on approve list"}]}},"CheckpointDecisionResponse":{"type":"object","nullable":true,"description":"Signifyd's Decision for this event.","required":["createdAt","checkpointAction"],"properties":{"createdAt":{"description":"The date and time when the checkpoint decision was generated. Formatted as ISO8601.","type":"string","format":"date-time","example":"2025-03-20T20:16:15.382889Z"},"checkpointAction":{"$ref":"#/components/schemas/CheckpointAction"},"checkpointActionReason":{"description":"The reason that the `checkpointAction` was taken.","type":"string","nullable":true,"example":"Power buyer on approve list"},"checkpointActionPolicy":{"description":"Identifies the policy responsible for the `checkpointAction`. If the action was determined by a policy configured in Decision Center, this field will contain the policy's name. If no Decision Center policy was applied, this field will indicate the default Signifyd policy.","type":"string","nullable":true,"example":"APPROVE_POWER_BUYERS"},"policies":{"$ref":"#/components/schemas/Policies"}}},"ReturnDecisionResponse":{"allOf":[{"$ref":"#/components/schemas/CheckpointDecisionResponse"},{"properties":{"rawScore":{"description":"A value from 0 to 1 indicating the associated risk with a RARE (Return, Appeasement, Refund, Exchange) request being fraudulent or abusive. 0 indicates the lowest risk, 1 indicates the highest risk. Field will only be returned to customers subscribed to the scoring product offering.","type":"number","nullable":true,"format":"double"},"featureMap":{"description":"Feature name to feature value mappings. Field will only be returned to customers subscribed to the product offering.","type":"object","nullable":true,"additionalProperties":{"type":"number","format":"double"},"example":{"OrderAmountPercentile":0.5}},"modelVersion":{"description":"The version of the model producing the rawScore.","type":"string","nullable":true}}}]},"CoverageDetails":{"type":"object","required":["amount","currency"],"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"The amount that Signifyd will reimburse for this coverage.","example":105.99,"type":"number"}]},"currency":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"The currency in which the `amount` is denominated","example":"GBP","type":"string"}]}}},"Coverage":{"description":"Details about the coverage that Signifyd will provide on each type of claim.","type":"object","nullable":true,"properties":{"fraudChargebacks":{"description":"The amount of coverage Signifyd will provide for a fraud chargeback or dispute.","$ref":"#/components/schemas/CoverageDetails"},"inrChargebacks":{"description":"The amount of coverage Signifyd will provide for a claim of Item Not Received.","$ref":"#/components/schemas/CoverageDetails"},"allChargebacks":{"description":"The amount of coverage Signifyd will provide for all types of chargebacks or disputes.","$ref":"#/components/schemas/CoverageDetails"}}},"AttemptReturnResponse":{"title":"AttemptReturnResponse","type":"object","required":["orderId","returnId"],"properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"returnId":{"$ref":"#/components/schemas/ReturnId"},"decision":{"$ref":"#/components/schemas/ReturnDecisionResponse"},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"GenericErrorBodyWithErrorDetails":{"title":"ErrorBodyWithErrorDetails","type":"object","required":["messages","traceId"],"properties":{"messages":{"type":"array","description":"Messages describing the error.","items":{"type":"string","example":"General error message."}},"traceId":{"type":"string","description":"If there is an error and you would like to contact Signifyd, please include this id in your support request.","example":"891f2e31d267dde"},"errors":{"type":"object","title":"InvalidFields","description":"If an error has occurred due to a specific request field, this will be highlighted in this section of the response.","example":{"purchase.discountCodes[0].code":["missing"]},"additionalProperties":{"type":"array","items":{"type":"string"},"description":"With the key being a json path to the invalid field, this describes what is wrong with the field."}}}},"GenericErrorBody":{"title":"ErrorBody","type":"object","required":["messages","traceId"],"properties":{"messages":{"type":"array","description":"Messages describing the error.","items":{"type":"string","example":"General error message."}},"traceId":{"type":"string","description":"If there is an error and you would like to contact Signifyd, please include this id in your support request.","example":"891f2e31d267dde"}}},"ReturnStatus":{"description":"The status of the Return. For every update you get to a Return after creation, you can call executeReturn to update the status of the return. If no returnStatus is provided, the default will be OPEN.\n  * `OPEN` - The return has been approved, but not processed.\n  * `CANCELED` - The return has been closed by either the customer or the merchant.\n  * `REFUNDED` - The return request has been processed and refunded.\n  * `REPLACED` - If a return resulted in a new item being sent, the replacement item has been allocated for delivery to the customer.\n  * `IN_ANALYSIS` - The return is being analyzed by the merchant.\n  * `DECLINED` - The return has been declined by the merchant.\n  * `RETURN_PENDING` - The return is pending and has not been processed.\n  * `PARTIAL_SETTLEMENT` - The request has been processed and a partial settlement (e.g., discount to keep, partial credits) was issued.","type":"string","enum":["OPEN","CANCELED","REFUNDED","REPLACED","IN_ANALYSIS","DECLINED","RETURN_PENDING","PARTIAL_SETTLEMENT"]},"ExecutedAt":{"description":"Timestamp indicating when the return's status or fulfillment details were updated.","type":"string","format":"date-time","example":"2025-09-10T17:00:00+0000"},"ReturnFulfillment":{"properties":{"trackingNumbers":{"description":"The tracking number(s) for the returned item(s).","type":"array","items":{"type":"string","example":"TBA005492092203"}},"refundTransactionId":{"description":"Transaction id for the refund issued for a refund claim.","type":"string","example":"f40b4f33-f3ac-42ac-a8d0-0a416a11f1b9"},"storeCreditId":{"description":"Id for the store credit issued for a refund claim.","type":"string","example":"cb6b59f4-e370-4456-8f19-36d0ee20779b"},"replacementOrderId":{"description":"Unique identifier for the replacement order issued either as a response to a refund claim or as an exchange for a return.","type":"string","example":"XGR-fad658a1d4"}}},"ExecuteReturn":{"allOf":[{"type":"object","properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"returnId":{"$ref":"#/components/schemas/ReturnId"},"returnStatus":{"$ref":"#/components/schemas/ReturnStatus"},"executedAt":{"$ref":"#/components/schemas/ExecutedAt"},"tags":{"description":"A list of attributes or short descriptors associated with the return.","type":"array","items":{"type":"string","example":"electronics"}}},"required":["orderId","returnId"]},{"$ref":"#/components/schemas/ReturnFulfillment"}]},"ExecuteReturnResponse":{"title":"ExecuteReturnResponse","required":["orderId","returnId"],"properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"returnId":{"$ref":"#/components/schemas/ReturnId"},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"ReturnStatusForRecordReturn":{"title":"ReturnStatus","description":"The status of the Return. For every update you get to a Return after creation, you can call recordReturn to update the status of the return.\n  * `CANCELED` - Request has been canceled by user.\n  * `REFUNDED` - The return request has been processed and refunded.\n  * `REPLACED` - If a return resulted in a new item being sent, the replacement item has been allocated for delivery to the customer.\n  * `DECLINED` - The return has been declined by the merchant.","type":"string","enum":["CANCELED","REFUNDED","REPLACED","DECLINED"]},"RecordReturn":{"title":"RecordReturn","allOf":[{"type":"object","required":["orderId"],"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"returnStatus":{"$ref":"#/components/schemas/ReturnStatusForRecordReturn"}}},{"$ref":"#/components/schemas/ReturnBase"},{"$ref":"#/components/schemas/ReturnFulfillment"}]},"RecordReturnResponse":{"title":"RecordReturnResponse","required":["orderId","returnId"],"properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"returnId":{"$ref":"#/components/schemas/ReturnId"},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"ReturnProductDisposition":{"description":"The state of the returned item once received from customer:\n  * `MISSING_NO_ALTERNATIVE_ITEM` - Item not returned; no other item included.\n  * `MISSING_WRONG_ITEM` - Incorrect item returned in place of original.\n  * `LIGHTLY_DAMAGED` - Item returned with minor damage or wear.\n  * `HEAVILY_DAMAGED` - Item returned with significant or unusable damage.\n  * `AS_EXPECTED` - Item returned in expected condition, matches original. \n  * `PROCESSING_REQUIRED` - Item returned but needs further inspection or action.","type":"string","enum":["MISSING_NO_ALTERNATIVE_ITEM","MISSING_WRONG_ITEM","LIGHTLY_DAMAGED","HEAVILY_DAMAGED","AS_EXPECTED","PROCESSING_REQUIRED"]},"ReturnFeedbackProduct":{"required":["reason"],"allOf":[{"properties":{"reason":{"$ref":"#/components/schemas/ReturnReason"},"subReason":{"$ref":"#/components/schemas/ReturnSubReason"},"disposition":{"$ref":"#/components/schemas/ReturnProductDisposition"}}},{"$ref":"#/components/schemas/Product"}]},"ReturnOutcome":{"description":"The outcome of the return once received by your return team.\n  * `GOOD` - the return was accepted and processed.\n  * `ABUSIVE` - the return violates the return policy.\n  * `FRAUD` - the return is fraudulent.\n  * `NO_ITEM_RETURNED` - the return was not received.","type":"string","example":"ABUSIVE","enum":["GOOD","ABUSIVE","FRAUD","NO_ITEM_RETURNED"]},"ReturnOutcomeReason":{"description":"The reason for the return outcome. Any reason will be accepted, but we strongly recommend mapping to one of the following keys if possible:\n  * `Used Item`\n  * `Wrong Item`\n  * `Empty Box`\n  * `Missing Items`\n  * `Trash Returned` \n  * `Damaged Item`","type":"string","example":"Used Item"},"FeedbackAt":{"description":"Timestamp indicating when the outcome was determined.","type":"string","format":"date-time","example":"2025-09-10T17:00:00+0000"},"ReturnFeedback":{"title":"ReturnFeedback","required":["orderId","returnId","returnOutcome"],"properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"returnId":{"$ref":"#/components/schemas/ReturnId"},"returnedItems":{"description":"A list of products that are going to be returned by the buyer.","items":{"$ref":"#/components/schemas/ReturnFeedbackProduct"},"type":"array"},"returnOutcome":{"$ref":"#/components/schemas/ReturnOutcome"},"returnOutcomeReason":{"$ref":"#/components/schemas/ReturnOutcomeReason"},"feedbackAt":{"$ref":"#/components/schemas/FeedbackAt"},"tags":{"description":"A list of attributes or short descriptors associated with the return.","type":"array","items":{"type":"string","example":"electronics"}}}},"ReturnFeedbackResponse":{"title":"ReturnFeedbackResponse","required":["orderId","returnId"],"properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"returnId":{"$ref":"#/components/schemas/ReturnId"},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"PostSaleActionId":{"type":"string","description":"Unique identifier for this return, refund, or appeasement request.","example":"e4056107-6720-431f-a9f4-fe0ff9b6c92a"},"UpdatePostSaleActionStatus":{"description":"Updated status of the post-sale action. If no Status is provided, the default will be OPEN.\n  * `OPEN` - The request has been created and is awaiting further updates or resolution.\n  * `CANCELED` - The request was canceled before fulfillment, refund, or processing.\n  * `REFUNDED` - A refund has been issued for the request.\n  * `REPLACED` - A replacement item has been issued to the buyer.\n  * `IN_ANALYSIS` - The request is under review, either manually or through automated evaluation.\n  * `DECLINED` - The request was reviewed and denied (e.g., due to policy or abuse).\n  * `RETURN_PENDING` - The buyer has been asked to return the item before a refund or replacement is issued.\n  * `PARTIAL_SETTLEMENT` - A partial refund, appeasement, or resolution has been granted.\n\nThe `CANCELED`, `PARTIAL_SETTLEMENT`, `REFUNDED`, `REPLACED` & `DECLINED` statuses are considered final. No more updates will be accepted once one of these statuses is reached.","type":"string","enum":["OPEN","CANCELED","REFUNDED","REPLACED","IN_ANALYSIS","DECLINED","RETURN_PENDING","PARTIAL_SETTLEMENT"]},"PostSaleActionRefundMethod":{"description":"Method used to issue the refund.\n  * `STORE_CREDIT` - Refund issued as store credit.\n  * `ORIGINAL_PAYMENT_INSTRUMENT` - Refund returned to original payment method.\n  * `NEW_PAYMENT_INSTRUMENT` - Refund issued to a different payment method.","type":"string","enum":["STORE_CREDIT","ORIGINAL_PAYMENT_INSTRUMENT","NEW_PAYMENT_INSTRUMENT"]},"PostSaleActionRefundHandling":{"description":"Describes when the refund was issued in the return lifecycle.\n  * `INSTANT` - Refund issued proactively, before carrier scan.\n  * `FAST` - Refund issued after first carrier scan.\n  * `PRE_PROCESSING` - Refund issued after package was received but before it was inspected.\n  * `POST_PROCESSING` - Refund issued after item verification\n  * `NO_RETURN` - Refund issued without requiring the item to be returned","type":"string","enum":["INSTANT","FAST","PRE_PROCESSING","POST_PROCESSING","NO_RETURN"]},"PostSaleActionRefund":{"description":"Object containing details about a refund that was issued for the post-sale action. Include only if a refund has been issued.","required":["method","amount","handling"],"properties":{"method":{"$ref":"#/components/schemas/PostSaleActionRefundMethod"},"amount":{"allOf":[{"description":"Total refund amount issued to the buyer.","type":"number","format":"double"},{"$ref":"#/components/schemas/Price"}],"minimum":0},"currency":{"allOf":[{"description":"Currency code for the refund amount (e.g., USD).","type":"string"},{"$ref":"#/components/schemas/Currency"}]},"itemIds":{"description":"List of itemIds that this refund applies to, if applicable.","type":"array","items":{"type":"string","example":"sparkly-sandals-xl-yellow-2020"}},"handling":{"$ref":"#/components/schemas/PostSaleActionRefundHandling"}}},"PostSaleActionReplacementHandling":{"description":"Describes when the replacement was issued in the return lifecycle.\n  * `INSTANT` - Replacement issued proactively, before carrier scan.\n  * `FAST` - Replacement issued after first carrier scan.\n  * `PRE_PROCESSING` - Replacement issued after package was received but before it was inspected.\n  * `POST_PROCESSING` - Replacement issued after item verification\n  * `NO_RETURN` - Replacement issued without requiring the item to be returned","type":"string","enum":["INSTANT","FAST","PRE_PROCESSING","POST_PROCESSING","NO_RETURN"]},"PostSaleActionReplacementItems":{"description":"Object containing replacement products and shipment metadata.","type":"object","properties":{"products":{"description":"List of replacement products being sent to the buyer. Structure must match the product object from Checkout or Sale API.","type":"array","items":{"$ref":"#/components/schemas/Product"}},"shipments":{"description":"List of shipment objects associated with replacement products. Structure must match the shipment object from Checkout or Sale API.","type":"array","items":{"$ref":"#/components/schemas/Shipment"}}}},"PostSaleActionReplacement":{"description":"Object containing details about any replacement that was issued for the post-sale action. Include only if a replacement has been issued.","required":["handling"],"properties":{"handling":{"$ref":"#/components/schemas/PostSaleActionReplacementHandling"},"replacementItems":{"$ref":"#/components/schemas/PostSaleActionReplacementItems"}}},"UpdatePostSaleActionBody":{"required":["orderId","postSaleActionId"],"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"postSaleActionId":{"allOf":[{"description":"Identifier of the post-sale action being updated. Must match the postSaleActionId from the original Create call.","type":"string"},{"$ref":"#/components/schemas/PostSaleActionId"}]},"status":{"$ref":"#/components/schemas/UpdatePostSaleActionStatus"},"updatedAt":{"description":"Timestamp of when the update occurred. If not provided, the current timestamp will be used.\n\nFormatted as `yyyy-MM-dd'T'HH:mm:ssZ` per ISO 8601.\"","type":"string","format":"date-time","example":"2024-09-30T15:30:00+01:00"},"refund":{"$ref":"#/components/schemas/PostSaleActionRefund"},"replacement":{"$ref":"#/components/schemas/PostSaleActionReplacement"},"tags":{"type":"array","description":"Optional labels or context for analytics and tracking.","items":{"type":"string","example":"PROMO_REFUND"}},"returnTrackingNumbers":{"type":"array","description":"The tracking number(s) for the returned item(s).","items":{"type":"string","example":"TBA005492092203"}}}},"ReturnFraud":{"required":["amount","currency"],"properties":{"amount":{"allOf":[{"description":"The total amount that Signifyd will reimburse for this coverage.","type":"number","format":"double"},{"$ref":"#/components/schemas/Price"}]},"currency":{"allOf":[{"description":"The currency in which the `amount` is denominated.","type":"string"},{"$ref":"#/components/schemas/Currency"}]}}},"PostSaleActionCoverage":{"required":["returnFraud"],"description":"Details about the coverage that Signifyd will provide on this claim.","properties":{"returnFraud":{"$ref":"#/components/schemas/ReturnFraud"}}},"UpdatePostSaleActionResponse":{"required":["orderId","postSaleActionId"],"properties":{"orderId":{"allOf":[{"description":"Unique identifier for an Order. This id must match the orderId used for the original Checkout or Sale request.","type":"string"},{"$ref":"#/components/schemas/OrderId"}]},"postSaleActionId":{"$ref":"#/components/schemas/PostSaleActionId"},"coverage":{"$ref":"#/components/schemas/PostSaleActionCoverage"}}},"RequestedAction":{"description":"Type of post-sale action for the item.\n  * `RETURN` - The buyer is sending the item back for a refund.\n  * `EXCHANGE` - The buyer wants a replacement item instead of a refund.\n  * `APPEASEMENT` - The buyer is requesting a refund or store credit without returning the item.","type":"string","enum":["RETURN","EXCHANGE","APPEASEMENT"]},"PostSaleActionReason":{"description":"The reason that the buyer is making this post-sale action:\n  * `BETTER_PRICE_AVAILABLE` - Buyer found a better price elsewhere.\n  * `BOUGHT_BY_MISTAKE` - Buyer unintentionally purchased the item\n  * `CANCELED` - Buyer canceled the item before it shipped.\n  * `CANCELED_BY_ISSUER` - Merchant canceled the item before it shipped.\n  * `DID_NOT_AUTHORIZE` - Buyer did not authorize the transaction.\n  * `DUPLICATE_ORDER` - Duplicate order was submitted by mistake.\n  * `ITEM_ARRIVED_TOO_LATE` - Item was delivered, but arrived too late.\n  * `ITEM_NOT_RECEIVED` - Buyer claims the item was never delivered.\n  * `NO_LONGER_NEEDED` - Buyer received the item but no longer needs it.\n  * `ITEM_DAMAGED` - Buyer reports the item arrived damaged.\n  * `SIGNIFICANTLY_NOT_AS_DESCRIBED` - Buyer reports the item received differs significantly from what was expected.\n  * `ORDER_ERROR` - Return is due to a fulfillment or shipping issue.\n  * `LOST` - The package or return has been lost.\n  * `OTHER` - Special refund or policy-based appeasement that doesn't fit into other categories.","type":"string","enum":["BETTER_PRICE_AVAILABLE","BOUGHT_BY_MISTAKE","CANCELED","CANCELED_BY_ISSUER","DID_NOT_AUTHORIZE","DUPLICATE_ORDER","ITEM_ARRIVED_TOO_LATE","ITEM_NOT_RECEIVED","NO_LONGER_NEEDED","ITEM_DAMAGED","SIGNIFICANTLY_NOT_AS_DESCRIBED","ORDER_ERROR","LOST","OTHER"]},"PostSaleActionSubReason":{"description":"Further information on the reason that the buyer is making this post-sale action. \n\nSubReasons should only be used alongside the relevant primary reason as laid out below:\n\nITEM_NOT_RECEIVED:\n  * `PACKAGE_NOT_RECEIVED` - Carrier marked the package as delivered, but buyer claims it wasn't received.\n  * `ITEM_MISSING_FROM_RECEIVED_PACKAGE` - Buyer received the package, but the item was missing.\n\n\nSIGNIFICANTLY_NOT_AS_DESCRIBED:\n  * `LARGER_THAN_EXPECTED` - Item is too large compared to expectations.\n  * `SMALLER_THAN_EXPECTED` - Item is too small compared to expectations.\n  * `WRONG_FIT` - Item does not fit the buyer properly.\n  * `WRONG_COLOR` - Item color does not match expectation.\n  * `WRONG_SIZE` - Wrong size was received.\n  * `QUALITY_ISSUE` - Item has a flaw or quality defect.\n\n\nORDER_ERROR:\n  * `NOT_DELIVERABLE` - Carrier was unable to deliver due to an address or routing issue.\n  * `NOT_ORDERED` - Buyer received an item they didn't order.\n\n\nLOST:\n  * `PACKAGE_NOT_RECEIVED` - Carrier lost the package in transit.\n  * `RETURN_NOT_RECEIVED` - Returned item was not received by merchant/DC.\n  * `MISSORT` - Item never left the distribution center.\n  * `NOT_DELIVERABLE` - Carrier attempted but failed delivery, and item is now untraceable.\n\n\nOTHER:\n  * `WAIVE_SHIPPING_FEE` - Refund issued to waive or cover shipping fees.\n  * `RETURN_RECEIVED_NO_REFUND_ISSUED` - Refund issued after a return was received but refund was missed.\n  * `RETURN_IN_STORE_NO_REFUND_ISSUED` - Refund for an in-store return where no refund was previously processed.\n  * `UPSET_CUSTOMER` - Appeasement/refund issued to resolve a negative customer experience.\n\n\nCANCELED:\n  * `BANK_ALERTED_FRAUD` - Merchant canceled the order due to fraud alert from payment provider.\n  * `INTERNAL_IDENTIFIED_FRAUD` - Merchant’s internal systems flagged the order as fraudulent.\n  * `CUSTOMER_REPORTED_FRAUD` - Buyer reported their order as fraudulent.\n  * `CANCELED_BY_USER` - Buyer voluntarily canceled the order.","type":"string","enum":["PACKAGE_NOT_RECEIVED","ITEM_MISSING_FROM_RECEIVED_PACKAGE","LARGER_THAN_EXPECTED","SMALLER_THAN_EXPECTED","WRONG_FIT","WRONG_COLOR","WRONG_SIZE","QUALITY_ISSUE","NOT_DELIVERABLE","NOT_ORDERED","RETURN_NOT_RECEIVED","MISSORT","WAIVE_SHIPPING_FEE","RETURN_RECEIVED_NO_REFUND_ISSUED","RETURN_IN_STORE_NO_REFUND_ISSUED","UPSET_CUSTOMER","BANK_ALERTED_FRAUD","INTERNAL_IDENTIFIED_FRAUD","CUSTOMER_REPORTED_FRAUD","CANCELED_BY_USER"]},"OrderProductId":{"description":"Unique identifier for a specific instance of an item within a post-sale action (e.g., return or exchange).  This is not the SKU — it's a per-item-level identifier that the merchant may assign when tracking individual units  (e.g., serialized inventory, barcoded units, etc.).","type":"string","example":"A90X-U234PQR500"},"PostSaleActionProduct":{"required":["itemId","shipmentId"],"properties":{"orderProductId":{"$ref":"#/components/schemas/OrderProductId"},"itemName":{"description":"`needed` The name of the product. If provided, can facilitate debugging and analytics.","type":"string","example":"Sparkly Sandals"},"itemPrice":{"allOf":[{"description":"`needed` The price paid for each item (not the aggregate).","type":"number","format":"double"},{"$ref":"#/components/schemas/Price"}]},"itemPriceCurrency":{"allOf":[{"description":"The currency in which the `itemPrice` and all other amounts are denominated. If omitted, the currency is assumed to be USD.","type":"string"},{"$ref":"#/components/schemas/Currency"}]},"itemQuantity":{"allOf":[{"description":"`needed` Number of units of this item included in the post-sale action.","type":"number","format":"double"},{"$ref":"#/components/schemas/Quantity"}]},"itemId":{"description":"Unique identifier for the item. Must match the itemId from Checkout or Sale API.","type":"string","example":"sparkly-sandals-xl-yellow-2020"},"shipmentId":{"description":"Unique identifier for the shipment. Must match the shipmentId used in the Fulfillment API.","type":"string","example":"4JLHENj6OY56D9BTcQcR"},"itemIsDigital":{"description":"`needed` Indicates whether the item is electronically delivered, e.g., gift cards.  If not provided, defaults to false.","type":"boolean","x-sig-needed":true,"example":false},"itemCategory":{"description":"`needed` The name of the top-level product category, e.g., Apparel.","type":"string","x-sig-needed":true,"example":"Apparel"},"itemSubCategory":{"description":"`needed` The name of the sub-category of the product if applicable, e.g., T-Shirt.","type":"string","x-sig-needed":true,"example":"Footwear"},"itemImage":{"description":"The url to an image of the product.","type":"string","example":"https://mystore.com/images/54205a06cecb905fb424479-large.jpg"},"itemUrl":{"description":"The url to the product's page on your site.","type":"string","example":"https://mystore.com/54205a06cecb905fb424479-large"},"itemWeight":{"description":"The weight of each item in grams.","type":"number","format":"double","example":200.12},"subscription":{"$ref":"#/components/schemas/Subscription"}}},"PostSaleActionReturnProduct":{"required":["requestedAction","reason","itemId","shipmentId"],"allOf":[{"properties":{"requestedAction":{"$ref":"#/components/schemas/RequestedAction"},"reason":{"$ref":"#/components/schemas/PostSaleActionReason"},"subReason":{"$ref":"#/components/schemas/PostSaleActionSubReason"}}},{"$ref":"#/components/schemas/PostSaleActionProduct"}]},"RequestedRefund":{"description":"Object detailing the expected refund amount and currency.","required":["amount"],"properties":{"amount":{"allOf":[{"description":"The total amount that the buyer has requested. This amount may not exceed the original price in the Checkout or Sale call.","type":"number","format":"double"},{"$ref":"#/components/schemas/Price"}],"minimum":0},"currency":{"allOf":[{"description":"The currency in which the `amount` is denominated. If not included, we assume the same currency as the original purchase.","type":"string"},{"$ref":"#/components/schemas/Currency"}]}}},"PostSaleActionInitiator":{"description":"Unique identifier for who initiated the post-sale action. This will be used if an internal employee initiated the post-sale action.","properties":{"employeeEmail":{"type":"string","description":"Unique email address associated with who initiated the post-sale action. Either `employeeEmail` or `employeeId` must be present.","example":"bob@example.com"},"employeeId":{"type":"string","description":"Unique identifier associated with who initiated the post-sale action. Either `employeeEmail` or `employeeId` must be present.","example":"0001234"}}},"CreatePostSaleRequestedActionBody":{"required":["orderId","postSaleActionId"],"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"postSaleActionId":{"allOf":[{"description":"Unique identifier for this return, refund, or appeasement request.","type":"string"},{"$ref":"#/components/schemas/PostSaleActionId"}]},"infoOnly":{"type":"boolean","description":"Set to `true` to skip evaluation and record for analytics only. Use `false` to request a decision. If no value sent, set to `false` by default.","example":false,"default":false},"requestedAt":{"type":"string","format":"date-time","description":"Timestamp of when the request was initiated. Defaults to current time if not provided.\n\nFormatted as `yyyy-MM-dd'T'HH:mm:ssZ` per ISO 8601.\"","example":"2021-09-30T15:30:00+01:00"},"device":{"$ref":"#/components/schemas/Device"},"items":{"description":"Array of items included in the post-sale action. Each item represents a return, exchange, or appeasement initiated by the buyer or agent.","items":{"$ref":"#/components/schemas/PostSaleActionReturnProduct"},"type":"array"},"requestedRefund":{"$ref":"#/components/schemas/RequestedRefund"},"initiator":{"$ref":"#/components/schemas/PostSaleActionInitiator"},"tags":{"type":"array","description":"Optional labels or categories to provide context for analytics or reporting.","items":{"type":"string","example":"electronics"}}}},"CreatePostSaleRequestedActionResponse":{"required":["orderId","postSaleActionId"],"properties":{"orderId":{"allOf":[{"description":"Unique identifier for an Order. This id must match the orderId used for the original Checkout or Sale request.","type":"string"},{"$ref":"#/components/schemas/OrderId"}]},"postSaleActionId":{"$ref":"#/components/schemas/PostSaleActionId"},"decision":{"$ref":"#/components/schemas/ReturnDecisionResponse"}}},"RecordPostSaleActionStatus":{"description":"Final outcome of the post-sale action. This status should reflect what has already occurred (e.g., REFUNDED, REPLACED).\n  * `CANCELED` - The request was canceled before fulfillment, refund, or processing.\n  * `REFUNDED` - A refund has been issued for the request.\n  * `REPLACED` - A replacement item has been issued to the buyer.\n  * `DECLINED` - The request was reviewed and denied (e.g., due to policy or abuse).\n  * `PARTIAL_SETTLEMENT` - A partial refund, appeasement, or resolution has been granted.","type":"string","enum":["CANCELED","REFUNDED","REPLACED","DECLINED","PARTIAL_SETTLEMENT"]},"RecordPostSaleActionBody":{"required":["orderId","postSaleActionId"],"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"postSaleActionId":{"allOf":[{"description":"Identifier for the completed post-sale action being logged. This must be unique across all records.","type":"string"},{"$ref":"#/components/schemas/PostSaleActionId"}]},"status":{"$ref":"#/components/schemas/RecordPostSaleActionStatus"},"requestedAt":{"type":"string","format":"date-time","description":"Timestamp of when the post-sale action occurred. Defaults to current time if not provided.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601.\"","example":"2021-09-30T15:30:00+01:00"},"device":{"$ref":"#/components/schemas/Device"},"items":{"description":"Array of items included in the completed return, exchange, or appeasement request.","items":{"$ref":"#/components/schemas/PostSaleActionReturnProduct"},"type":"array"},"refund":{"$ref":"#/components/schemas/PostSaleActionRefund"},"replacement":{"$ref":"#/components/schemas/PostSaleActionReplacement"},"initiator":{"$ref":"#/components/schemas/PostSaleActionInitiator"},"tags":{"type":"array","description":"Optional labels to provide context for analytics or reporting. e.g., IN_STORE_RETURN, PROMO_REFUND","items":{"type":"string","example":"PROMO_REFUND"}}}},"RecordPostSaleActionResponse":{"required":["orderId","postSaleActionId"],"properties":{"orderId":{"allOf":[{"description":"Unique identifier for an Order. This id must match the orderId used for the original Checkout or Sale request."},{"$ref":"#/components/schemas/OrderId"}]},"postSaleActionId":{"$ref":"#/components/schemas/PostSaleActionId"}}},"ReturnFeedbackProductDisposition":{"description":"Observed condition or final state of the returned item.\n  * `MISSING_NO_ALTERNATIVE_ITEM` - Item missing and nothing else returned.\n  * `MISSING_WRONG_ITEM` - Wrong item returned.\n  * `LIGHTLY_DAMAGED` - Item returned with minor damage.\n  * `HEAVILY_DAMAGED` - Item returned with significant damage.\n  * `AS_EXPECTED` - Item returned as expected. \n  * `PROCESSING_REQUIRED` - Item under additional inspection or analysis.","type":"string","enum":["MISSING_NO_ALTERNATIVE_ITEM","MISSING_WRONG_ITEM","LIGHTLY_DAMAGED","HEAVILY_DAMAGED","AS_EXPECTED","PROCESSING_REQUIRED"]},"PostSaleActionFeedbackReturnProduct":{"required":["itemId","disposition"],"properties":{"itemName":{"description":"`needed` The name of the product. If provided, can facilitate debugging and analytics.","type":"string","example":"Sparkly Sandals"},"itemQuantity":{"allOf":[{"description":"`needed` Number of units of this item included in the post-sale action.","type":"number","format":"double"},{"$ref":"#/components/schemas/Quantity"}],"minimum":0},"itemId":{"description":"Unique identifier for the item. Must match the itemId from Checkout or Sale API.","type":"string","example":"sparkly-sandals-xl-yellow-2020"},"orderProductId":{"$ref":"#/components/schemas/OrderProductId"},"shipmentId":{"description":"Identifier of the shipment associated with the item. Optional but recommended for linking to fulfillment.","type":"string","example":"4JLHENj6OY56D9BTcQcR"},"disposition":{"$ref":"#/components/schemas/ReturnFeedbackProductDisposition"}}},"PostSaleActionReturnOutcome":{"description":"Final classification of the return after inspection or analysis. \n  * `GOOD` - The return was legitimate. The item was received in the expected condition, and the return complied with policies.\n  * `FRAUD` - The return was blatantly fraudulent. The expected item was not returned — for example, the box was empty, the item was fake, or something completely different was sent back.\n  * `ABUSIVE` - The return was manipulative or excessive, but the correct item was returned. Examples include wardrobing (used then returned), bracketing, or excessive return volume that violates policy intent.","type":"string","example":"ABUSIVE","enum":["GOOD","FRAUD","ABUSIVE"]},"PostSaleActionReturnOutcomeReason":{"description":"Additional detail that helps explain why a return was classified as Fraud or Abuse.","type":"string","example":"Used Item"},"PostSaleActionReturnFeedbackAt":{"description":"Timestamp indicating when the outcome was determined.","type":"string","format":"date-time","example":"2025-09-10T17:00:00+0000"},"SubmitPostSaleActionFeedbackBody":{"required":["orderId","postSaleActionId"],"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"postSaleActionId":{"allOf":[{"description":"Identifier of the original post-sale action this feedback relates to.","type":"string"},{"$ref":"#/components/schemas/PostSaleActionId"}]},"items":{"description":"A list of products that were returned by the buyer.","items":{"$ref":"#/components/schemas/PostSaleActionFeedbackReturnProduct"},"type":"array"},"outcome":{"$ref":"#/components/schemas/PostSaleActionReturnOutcome"},"outcomeReason":{"$ref":"#/components/schemas/PostSaleActionReturnOutcomeReason"},"feedbackAt":{"$ref":"#/components/schemas/PostSaleActionReturnFeedbackAt"}}},"SubmitPostSaleActionFeedbackResponse":{"required":["orderId","postSaleActionId"],"properties":{"orderId":{"allOf":[{"description":"Unique identifier for an Order. This id must match the orderId used for the original Checkout or Sale request.","type":"string"},{"$ref":"#/components/schemas/OrderId"}]},"postSaleActionId":{"$ref":"#/components/schemas/PostSaleActionId"}}},"LoginMethod":{"description":"`needed` Method used for authentication.\n  * `PASSWORD` - User provided a password for this login attempt.\n  * `PASSKEY` - User provided a passkey for this login attempt.\n  * `GOOGLE` - User logged in with a Google account.\n  * `FACEBOOK` - User logged in with a Facebook account.\n  * `APPLE` - User logged in with an Apple account.\n  * `LINKEDIN` - User logged in with a LinkedIn account.\n  * `X` - User logged in with an X account.\n  * `EMAIL_OTP` - User logged in with an email one time password.\n  * `PHONE_OTP` - User logged in with a phone one time password.\n  * `OTHER` - User logged in with a different method from the ones listed above.","type":"string","enum":["PASSWORD","PASSKEY","GOOGLE","FACEBOOK","APPLE","LINKEDIN","X","EMAIL_OTP","PHONE_OTP","OTHER"],"example":"PASSWORD"},"AccountType":{"description":"Indicating the role of the account; one of BUYER, SELLER, BUSINESS, OTHER.","type":"string","enum":["BUYER","SELLER","BUSINESS","OTHER"],"example":"BUYER"},"AccountIntegrityDevice":{"title":"Device","description":"`needed` Device & fingerprint context.","type":"object","properties":{"clientIpAddress":{"description":"`needed` The IP Address of the device or browser. You must provide a valid IP address syntax. Do not provide local host IP or CDN IP information. Fraud decisioning requires end client IP information.","type":"string","example":"75.100.88.78","x-sig-needed":true},"sessionId":{"description":"`needed` The unique id for the user's session. This must be the same as the identifier provided by your implementation of Signifyd's device fingerprinting.","type":"string","example":"82ce5fca-c2b2-429b-b487-6c3053469f85","x-sig-needed":true},"originatingUserAgent":{"description":"Fallback user agent string if profiling fails.","type":"string","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64)"}}},"EventChannel":{"description":"`needed` The channel through which the account integrity event was initiated.\n  * `WEB` - Event originated from a web browser.\n  * `MOBILE_APP` - Event originated from a native mobile application.","type":"string","enum":["WEB","MOBILE_APP"],"example":"WEB"},"AccountOpeningRequest":{"title":"AccountOpeningRequest","type":"object","required":["openingId","username","email","signupMethod","accountType","createdAt"],"properties":{"openingId":{"description":"Unique identifier for this opening event.","type":"string","example":"q49sgfkj49"},"username":{"description":"The username that will be associated with the account. Please supply this even if it is the same as the email.","type":"string","example":"bobiverse"},"fullName":{"type":"string","example":"Bob Norman","description":"`needed` The full name of the user.","x-sig-needed":true},"accountId":{"description":"`needed` Your globally unique identifier for registered user accounts. Use this as the persistent user identifier,  consistent across Account Integrity APIs.","type":"string","example":"q49sgfkj49","x-sig-needed":true},"email":{"description":"The email address that will be associated with the account.","type":"string","format":"email","example":"bob@example.com"},"emailVerified":{"description":"`True` if the user successfully completed an email verification (e.g. OTP). `False` if verification was not performed.","type":"boolean","example":true},"phone":{"description":"The phone number that will be associated with the account.","type":"string","example":"+442071838750"},"phoneVerified":{"description":"`True` if the user successfully completed a phone verification (e.g. OTP). `False` if verification was not performed.","type":"boolean","example":true},"createdAt":{"description":"The date and time of when the account opening was requested.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-20T19:00:00+0000"},"signupMethod":{"$ref":"#/components/schemas/LoginMethod"},"accountType":{"$ref":"#/components/schemas/AccountType"},"device":{"$ref":"#/components/schemas/AccountIntegrityDevice","x-sig-needed":true},"eventChannel":{"$ref":"#/components/schemas/EventChannel","x-sig-needed":true},"tags":{"description":"A list of attributes or short descriptors associated with the account opening.","type":"array","items":{"type":"string","example":"JULY_FACEBOOK_CAMPAIGN"}}}},"SignifydId":{"title":"signifydId","description":"Signifyd's unique ID for this event.","type":"integer","format":"int64","example":44},"AccountIntegrityCheckpointAction":{"description":"The suggested action that should be taken for the event.\n* `ALLOW` - Allow the event to be processed.\n* `DENY` - Block the event from being processed further.\n* `STEP_UP` - Present the user with additional authentication challenges before allowing them to proceed.\n* `FLAG` - Flag the event for manual review while allowing it to proceed.\n* `ALERT` - Generate an alert for suspicious activity while allowing the event to proceed.\n","type":"string","enum":["ALLOW","DENY","STEP_UP","FLAG","ALERT"],"example":"ALLOW"},"AccountIntegrityPolicies":{"type":"object","nullable":true,"description":"Policies configured at the Checkpoint in Decision Center.","required":["default","overriding"],"properties":{"default":{"description":"The default policy configured at the Checkpoint in Decision Center.","$ref":"#/components/schemas/Policy"},"overriding":{"description":"The overriding policies configured at the Checkpoint in Decision Center.","items":{"$ref":"#/components/schemas/Policy"},"type":"array"}},"example":{"default":{"name":"SIGNIFYD_DECISION","status":"EVALUATED_TRUE","action":"DENY","reason":"SUSPICIOUS_USER_PROFILE"},"overriding":[{"name":"APPROVE_POWER_BUYERS","status":"EVALUATED_TRUE","action":"ALLOW","reason":"Power buyer on approve list"}]}},"AccountIntegrityDecisionResponse":{"type":"object","nullable":true,"description":"Signifyd's Decision for this event.","required":["createdAt","checkpointAction"],"properties":{"createdAt":{"description":"The date and time when the checkpoint decision was generated. Formatted as ISO8601.","type":"string","format":"date-time","example":"2025-03-20T20:16:15.382889Z"},"checkpointAction":{"$ref":"#/components/schemas/AccountIntegrityCheckpointAction"},"checkpointActionReason":{"description":"The reason that the `checkpointAction` was taken.","type":"string","nullable":true,"example":"Power buyer on approve list"},"checkpointActionPolicy":{"description":"Identifies the policy responsible for the `checkpointAction`. If the action was determined by a policy configured in Decision Center, this field will contain the policy's name. If no Decision Center policy was applied, this field will indicate the default Signifyd policy.","type":"string","nullable":true,"example":"APPROVE_POWER_BUYERS"},"policies":{"$ref":"#/components/schemas/AccountIntegrityPolicies"}}},"AccountOpeningResponse":{"title":"AccountOpeningResponse","type":"object","required":["signifydId","openingId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"openingId":{"description":"Unique identifier for this opening event.","type":"string","example":"q49sgfkj49"},"decision":{"$ref":"#/components/schemas/AccountIntegrityDecisionResponse"}}},"AccountFeedbackOutcome":{"description":"The final outcome of the event:\n  * `ALLOWED` - Event was allowed.\n  * `DENIED` - Event was denied.\n  * `STEP_UP_SUCCESSFUL` - Event was challenged and step-up challenge was completed successfully.\n  * `STEP_UP_FAILED` - Event was challenged and step-up challenge was failed.\n  * `ALERT_ACKNOWLEDGED` - Alert was acknowledged.\n  * `OTHER` - Other event outcome.","type":"string","enum":["ALLOWED","DENIED","STEP_UP_SUCCESSFUL","STEP_UP_FAILED","ALERT_ACKNOWLEDGED","OTHER"]},"AccountFeedback":{"title":"AccountFeedback","type":"object","required":["outcome","recordedAt","overridden"],"properties":{"outcome":{"$ref":"#/components/schemas/AccountFeedbackOutcome"},"outcomeReason":{"description":"Optional short reason code (e.g., EMAIL_VERIFIED, SMS_TIMEOUT, USER_REPORTED, MANUAL_REVIEW_REQUIRED).","type":"string","example":"EMAIL_VERIFIED"},"overridden":{"description":"Set to true if your system took a different action than Signifyd’s recommendation.","type":"boolean","example":false},"recordedAt":{"description":"The date and time when the feedback was recorded.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO-8601.","type":"string","format":"date-time","example":"2024-05-20T09:45:00Z"}}},"AccountOpeningFeedbackRequest":{"title":"Account Opening Feedback Request","allOf":[{"type":"object","required":["openingId"],"properties":{"openingId":{"description":"A unique ID for this account opening that you can use to retrieve this opening event later.","type":"string","example":"e33febb4-4bb7-4264-8001-504a8d7fc2d7"},"accountId":{"description":"`needed` Your globally unique identifier for registered user accounts. Use this as the persistent user identifier,  consistent across Account Integrity APIs.\nThis is required in the event that accountId was not supplied in the initial account opening request, but the  account was successfully created.","type":"string","example":"q49sgfkj49","x-sig-needed":true}}},{"$ref":"#/components/schemas/AccountFeedback"}]},"AccountOpeningFeedbackResponse":{"title":"AccountOpeningFeedbackResponse","type":"object","required":["signifydId","openingId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"openingId":{"description":"Opening ID from the original Account Opening event.","type":"string","example":"q49sgfkj49"}}},"ModificationTypes":{"description":"The types of modification to the account.\n  * `EMAIL_UPDATE` - The user has requested to update their email address.\n  * `PASSWORD_CHANGE` - The user has requested to change their password.\n  * `PAYMENT_METHOD_ADD` - The user has requested to add a payment method.\n  * `ADDRESS_UPDATE` - The user has requested to updated their address.\n  * `PHONE_UPDATE` - The user has requested to update their phone number.\n  * `NAME_UPDATE` - The user has requested to update their full name.\n  * `OTHER_UPDATE` - The user has requested to update something different from the above.","type":"array","items":{"type":"string","enum":["EMAIL_UPDATE","PASSWORD_CHANGE","PAYMENT_METHOD_ADD","ADDRESS_UPDATE","PHONE_UPDATE","NAME_UPDATE","OTHER_UPDATE"]},"example":["PAYMENT_METHOD_ADD"]},"BasePaymentDetails":{"title":"PaymentDetails","type":"object","properties":{"billingAddress":{"description":"The billing address saved on the Account.","allOf":[{"$ref":"#/components/schemas/Address"}]},"accountHolderTaxID":{"description":"The unique taxpayer identifier for the account user.  Due to legal restrictions, the values currently accepted here are Brazilian CPF, Brazilian CNPJ, Chilean RUT, Argentinian DNI, Colombian CC, Costa Ricans Cédula de identidad, Guatemalan DPI and Peruvian DNI numbers.  All other values provided will be removed.\n","type":"string","example":"231.002.999-00"},"accountHolderTaxIDCountry":{"description":"The country that issued the userAccountTaxId. Due to legal restrictions, the values currently accepted here are AR, BR, CL, CO, CR, GT and PE.\n","type":"string","example":"BR"},"accountLast4":{"description":"The last 4 digits of the bank account number saved to the account.","type":"string","example":"2548"},"abaRoutingNumber":{"description":"The routing number (ABA) of the bank account saved to the account.","type":"string","example":"121122676"},"bankRoutingNumber":{"description":"The routing number of the non-US bank account that was saved to this account, such as a SWIFT code.  If a US bank account, please use abaRoutingNumber.\n","type":"string"},"bankRoutingCountry":{"description":"The country of origin of the bank account that was saved to this account. Country must be provided along with bankRoutingNumber. If you send a US ABA Number, this field is not required.\n","type":"string"},"cardBin":{"description":"`needed` The first six or eight digits of the credit card, the bank identification number,  which uniquely identifies the issuer.","type":"string","example":"441104","x-sig-needed":true},"cardExpiryMonth":{"description":"`needed` Month representation of the expiration month of the credit card.","type":"integer","format":"int32","example":3,"x-sig-needed":true},"cardExpiryYear":{"description":"`needed` yyyy representation of the expiration year of the credit card.","type":"integer","format":"int32","example":2022,"x-sig-needed":true},"cardLast4":{"description":"`needed` The last four digits of the credit card number.","type":"string","example":"0215","x-sig-needed":true}}},"AccountModificationPaymentDetails":{"allOf":[{"properties":{"accountHolderName":{"description":"`needed` The full name of the account holder. This should be provided by the financial institution or payment provider.\n","type":"string","example":"Bob Norman","x-sig-needed":true}}},{"$ref":"#/components/schemas/BasePaymentDetails"}]},"CvvResponseCode":{"title":"CvvResponseCode","description":"`needed` The response code returned by your gateway for the Card Verification Value (CVV) check. CVV Response codes from the following gateways are supported. Example provided from PAYPAL_DIRECT.\n  * `ADYEN`\n  * `BLUESNAP`\n  * `BRAINTREE`\n  * `CHASE_PAYMENTECH`\n  * `CYBERSOURCE`\n  * `FIRST_DATA`\n  * `FISERV`\n  * `NMI`\n  * `ORBITAL`\n  * `PAYPAL_DIRECT`\n  * `PAYPAL_EXPRESS`\n  * `PAYPAL_STANDARD`\n  * `PAYPAL_PRO`\n  * `PAYFLOW`\n  * `STRIPE`\n  * `PXP`\n  * `TSYS`\n  * `VANTIV`\n  * `WORLDPAY`\n  * `WORLDPAY_RAFT`\n  * `WORLDPAY_VAP`\n  * `WORLDPAY_WPG`\n","type":"string","x-sig-needed":true,"example":"S"},"AvsCvvVerification":{"title":"AvsCvvVerification","type":"object","properties":{"cvvResponseCode":{"$ref":"#/components/schemas/CvvResponseCode"},"avsResponseCode":{"type":"string","description":"`needed` The Address Verification System (AVS) code that was returned by your payment gateway. AVS Response codes from the following gateways are supported. Example provided from from PAYPAL_DIRECT.\n  * `ADYEN`\n  * `AUTHORIZE_NET`\n  * `BLUESNAP`\n  * `BRAINTREE`\n  * `CHASE_PAYMENTECH`\n  * `CYBERSOURCE`\n  * `FIRST_DATA`\n  * `FISERV`\n  * `NMI`\n  * `ORBITAL`\n  * `PAYABL`\n  * `PAYPAL_DIRECT`\n  * `PAYPAL_EXPRESS`\n  * `PAYPAL_STANDARD`\n  * `PAYPAL_PRO`\n  * `PXP`\n  * `TSYS`\n  * `VANTIV`\n  * `WORLDPAY`\n  * `WORLDPAY_RAFT`\n  * `WORLDPAY_VAP`\n  * `WORLDPAY_WPG`\n","example":"M","x-sig-needed":true}}},"AvsResponseCodes":{"title":"AvsResponseCodes","description":"Send address match code and zip match code separately if your payment gateway returned two AVS responses - one each for address and zip.","type":"object","properties":{"addressMatchCode":{"description":"The response code returned by your gateway for the address match. Address match codes from the following gateways are supported. Example provided from BRAINTREE. * `BRAINTREE` * `PAYFLOW` * `STRIPE`\n","type":"string","example":"M"},"zipMatchCode":{"description":"The response code returned by your gateway for the zip match. ZIP match codes from the following gateways are supported. Example provided from BRAINTREE. * `BRAINTREE` * `PAYFLOW` * `STRIPE`\n","type":"string","example":"M"}}},"DecomposedAvsCvvVerification":{"title":"DecomposedAvsCvvVerification","type":"object","properties":{"cvvResponseCode":{"$ref":"#/components/schemas/CvvResponseCode"},"avsResponse":{"$ref":"#/components/schemas/AvsResponseCodes"}}},"Verifications":{"title":"Verifications","type":"object","oneOf":[{"$ref":"#/components/schemas/AvsCvvVerification"},{"$ref":"#/components/schemas/DecomposedAvsCvvVerification"}]},"NewPaymentDetails":{"allOf":[{"$ref":"#/components/schemas/AccountModificationPaymentDetails"},{"properties":{"gateway":{"description":"`needed` The name of the payment gateway or financial institution that processed the transaction.","type":"string","example":"braintree","x-sig-needed":true},"verifications":{"$ref":"#/components/schemas/Verifications"}}}]},"NewPaymentMethod":{"title":"NewPaymentMethod","description":"New payment details, required when PAYMENT_METHOD_ADD is present in modificationTypes.","type":"object","required":["paymentMethod"],"properties":{"paymentMethod":{"description":"The name of the Payment Method being added to the Account. Any name will be accepted, but we strongly recommend mapping to one of the following keys if possible:\n  * `CREDIT_CARD`\n  * `GIFT_CARD`\n  * `DEBIT_CARD`\n  * `PREPAID_CARD`\n  * `SNAP_CARD`\n  * `BANK_ACCOUNT`\n","type":"string","example":"CREDIT_CARD"},"paymentDetails":{"$ref":"#/components/schemas/NewPaymentDetails"}}},"AccountIntegrityNewAddress":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"addressType":{"description":"The type of address.","type":"string","enum":["SHIPPING","BILLING"]}}}]},"AccountIntegritySavedAddress":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"addressType":{"description":"The type of address.","type":"string","enum":["SHIPPING","BILLING"]},"addressLastUpdatedAt":{"description":"The date this address was last updated. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ`. See the dates section of the  Introduction for more information about date formats.\n","example":"2025-12-23T13:57:40-07:00","type":"string","format":"date-time"}}}]},"AccountModificationSavedPaymentMethod":{"title":"SavedPaymentMethod","type":"object","required":["paymentMethod"],"properties":{"paymentMethodLastUpdatedAt":{"description":"The date this payment information was last updated or verified. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ`. See the dates section of the Introduction for more information about date formats.\n","example":"2020-12-23T13:57:40-07:00","type":"string","format":"date-time"},"paymentMethod":{"description":"The name of the Payment Method being added to the Account. Any name will be accepted, but we strongly recommend mapping to one of the following keys if possible:\n  * `CREDIT_CARD`\n  * `GIFT_CARD`\n  * `DEBIT_CARD`\n  * `PREPAID_CARD`\n  * `SNAP_CARD`\n  * `BANK_ACCOUNT`\n","type":"string","example":"CREDIT_CARD"},"paymentDetails":{"$ref":"#/components/schemas/AccountModificationPaymentDetails"}}},"ModificationUserAccount":{"type":"object","title":"UserAccount","description":"Current context on the account being modified.","required":["accountId","username","email","accountType"],"properties":{"accountId":{"description":"Your globally unique identifier for registered user accounts. Use this as the persistent user identifier,  consistent across Account Integrity APIs.","type":"string","example":"q49sgfkj49"},"accountType":{"$ref":"#/components/schemas/AccountType"},"createdAt":{"description":"`needed` The date and time when the account was originally created.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-15T12:00:00Z","x-sig-needed":true},"username":{"description":"The username associated with the account. Please supply this even if it is the same as the `email`.","type":"string","example":"bobiverse"},"fullName":{"description":"The full name of the user currently on file for the account.","type":"string","example":"Bob Norman"},"email":{"description":"The primary email address associated with the account.","type":"string","format":"email","example":"bob@example.com"},"phone":{"description":"The primary phone number associated with the account.","type":"string","example":"+442071838750"},"emailLastUpdatedAt":{"description":"The date and time when the accounts email was last updated.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-20T19:00:00+0000"},"phoneLastUpdatedAt":{"description":"The date and time when the accounts phone number was last updated.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-20T19:00:00+0000"},"passwordLastUpdatedAt":{"description":"The date and time when the accounts password was last updated.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-20T19:00:00+0000"},"savedAddresses":{"items":{"$ref":"#/components/schemas/AccountIntegritySavedAddress"},"type":"array","description":"List of addresses associated with the account."},"savedPayments":{"items":{"$ref":"#/components/schemas/AccountModificationSavedPaymentMethod"},"type":"array","description":"List of saved payment methods on the account."}}},"SessionMetadata":{"description":"Optional authentication session context details.","type":"object","properties":{"sessionAgeSeconds":{"description":"Seconds since session start.","type":"integer","format":"int64","example":641},"sessionIssuedAt":{"description":"The date and time when the current session was issued or authenticated by your system.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-20T19:00:00+0000"},"sessionLastActivityAt":{"description":"The date and time of last session activity.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-20T19:00:00+0000"},"sessionIp":{"description":"IP address when the session was first created.","type":"string","example":"51.202.206.33"},"sessionLastUserAgent":{"description":"The last user agent string seen in this session.","type":"string","example":"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0"}}},"AccountModificationRequest":{"title":"AccountModificationRequest","type":"object","required":["modificationId","modificationTypes","modifiedAt","userAccount"],"properties":{"modificationId":{"description":"A unique identifier for the modification event.","type":"string","example":"e31b770c"},"modificationTypes":{"$ref":"#/components/schemas/ModificationTypes"},"modifiedAt":{"description":"The date and time of when the user requested the account modification.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO-8601.","type":"string","format":"date-time","example":"2024-05-20T09:45:00Z"},"newEmail":{"description":"New email address, required when EMAIL_UPDATE is present in modificationTypes.","type":"string","example":"bob@gmail.com"},"newPhone":{"description":"New phone number, required when PHONE_UPDATE is present in modificationTypes.","type":"string","example":"+442071838750"},"newFullName":{"description":"New full name, required when NAME_UPDATE is present in modificationTypes.","type":"string","example":"Bob Norman"},"newPayment":{"$ref":"#/components/schemas/NewPaymentMethod"},"newAddress":{"description":"New address object, required when ADDRESS_UPDATE is present in modificationTypes.","allOf":[{"$ref":"#/components/schemas/AccountIntegrityNewAddress"}]},"loginMethod":{"$ref":"#/components/schemas/LoginMethod"},"lastLoginAt":{"description":"`needed` The date and time of the previous successful login.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-06-01T14:22:35Z"},"userAccount":{"$ref":"#/components/schemas/ModificationUserAccount"},"device":{"$ref":"#/components/schemas/AccountIntegrityDevice","x-sig-needed":true},"sessionMetadata":{"$ref":"#/components/schemas/SessionMetadata"},"eventChannel":{"$ref":"#/components/schemas/EventChannel","x-sig-needed":true},"tags":{"description":"A list of attributes or short descriptors associated with the account modification.","type":"array","items":{"type":"string","example":"JULY_FACEBOOK_CAMPAIGN"}}}},"AccountModificationResponse":{"title":"AccountModificationResponse","type":"object","required":["signifydId","modificationId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"modificationId":{"description":"A unique ID for this account modification.","type":"string","example":"q49sgfkj49"},"decision":{"$ref":"#/components/schemas/AccountIntegrityDecisionResponse"}}},"AccountModificationFeedbackRequest":{"title":"Account Modification Feedback Request","allOf":[{"type":"object","required":["modificationId"],"properties":{"modificationId":{"description":"A unique ID for this account modification that you can use to retrieve this modification event later.","type":"string","example":"e33febb4-4bb7-4264-8001-504a8d7fc2d7"},"accountId":{"description":"`needed` Your globally unique identifier for registered user accounts. Use this as the persistent user identifier,  consistent across Account Integrity APIs.","type":"string","example":"q49sgfkj49","x-sig-needed":true}}},{"$ref":"#/components/schemas/AccountFeedback"}]},"AccountModificationFeedbackResponse":{"title":"AccountModificationFeedbackResponse","type":"object","required":["signifydId","modificationId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"modificationId":{"description":"Modification ID from the original Account Modification event.","type":"string","example":"q49sgfkj49"}}},"DiscountCode":{"type":"object","properties":{"code":{"description":"The name of the discount code entered during checkout. If the discount code applied does not have a name or if you do not have access to it, leave this field empty, and we will apply the default value.","type":"string","example":"LABOR_DAY_SALE","default":"GENERIC"}}},"AbsoluteDiscountCode":{"title":"AbsoluteDiscountCode","allOf":[{"$ref":"#/components/schemas/DiscountCode"},{"required":["code"],"properties":{"amount":{"description":"The fixed amount of the discount applied. For example, if this discount code gives $9.50 off original price, then supply 9.5 here. This field is required when a discount code is provided.","type":"number","format":"double","example":9.5}}}]},"PercentDiscountCode":{"title":"PercentDiscountCode","allOf":[{"$ref":"#/components/schemas/DiscountCode"},{"required":["code"],"properties":{"percentage":{"description":"The percentage discount that was applied to original price.  For example, if the code gives 20% off the original price, then supply 0.2 here. This field is required when a discount code is provided.","type":"number","format":"double","minimum":0,"maximum":1,"example":0.2}}}]},"DiscountCodes":{"anyOf":[{"$ref":"#/components/schemas/AbsoluteDiscountCode"},{"$ref":"#/components/schemas/PercentDiscountCode"}]},"Membership":{"type":"object","title":"Membership","required":["membershipName"],"properties":{"membershipId":{"description":"Unique identifier for this membership in the merchant's system.","type":"string","example":"3cf0e3bd188949798d4d23d3085953e8"},"phoneNumber":{"description":"The phone number associated with this membership.","type":"string","example":"+442071838750"},"emailAddress":{"description":"Email address associated with this membership.","type":"string","format":"email","nullable":false,"example":"bob@example.com"},"membershipName":{"description":"Name of the membership.","type":"string","example":"FRESHPASS"}}},"GatewayStatusCode":{"title":"TransactionStatus","description":"This status of the payment authorization request. * `SUCCESS` - The payment was successfully authorized. * `PENDING` - It is not possible to obtain the final status of the payment at this time. * `FAILURE` - The payment failed. * `ERROR` - There was an error when the payment was being processed. * `CANCELLED` - The payment was canceled before processing was complete. * `EXPIRED` - The payment expired before processing was complete. * `SOFTDECLINE` - The issuing bank requires further authentication to complete payment processing. Retry with 3D Secure.\n","enum":["SUCCESS","PENDING","FAILURE","ERROR","CANCELLED","EXPIRED","SOFTDECLINE"],"type":"string","example":"SUCCESS"},"LoginUserAccount":{"description":"Details about the user account that was being attempted to login to.","type":"object","required":["username","email","accountId","accountType"],"properties":{"username":{"description":"The username associated with the account. Please supply this even if it is the same as the `email`.","type":"string","example":"jsmith123"},"fullName":{"description":"The full name of the user currently on file for the account.","type":"string","example":"Bob Norman"},"createdAt":{"description":"`needed` The date and time when the account was originally created.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-15T12:00:00Z","x-sig-needed":true},"accountId":{"description":"Your globally unique identifier for registered user accounts. Use this as the persistent user identifier,  consistent across Account Integrity APIs.","type":"string","example":"e33febb4-4bb7-4264-8001-504a8d7fc2d7"},"accountType":{"$ref":"#/components/schemas/AccountType"},"email":{"description":"The primary email address associated with the account.","type":"string","format":"email","example":"jsmith123@example.com"},"phone":{"description":"The primary phone number associated with the account.","type":"string","example":"+16045555555"},"emailLastUpdatedAt":{"description":"The date and time when the accounts email was last updated.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-15T12:00:00Z"},"phoneLastUpdatedAt":{"description":"The date and time when the accounts phone number was last updated.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-15T12:00:00Z"},"passwordLastUpdatedAt":{"description":"The date and time when the accounts password was last updated.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-09-15T12:00:00Z"}}},"RecordLoginRequest":{"type":"object","required":["loginId","loginMethod","loginResult","loginAt","userAccount"],"properties":{"loginId":{"description":"Unique identifier for this login event.","type":"string","example":"e33febb4-4bb7-4264-8001-504a8d7fc2d7"},"loginMethod":{"$ref":"#/components/schemas/LoginMethod","x-sig-needed":true},"loginResult":{"description":"The result of the authentication attempt.\n  * `SUCCESS` - User provided a valid login for this account.\n  * `FAILURE` - User provided an invalid login for this account.","type":"string","enum":["SUCCESS","FAILURE"],"example":"SUCCESS"},"loginAt":{"description":"The date and time when the current login was attempted. \n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO 8601. See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2024-06-01T14:22:35Z"},"lastLoginAt":{"description":"The date and time of the user's previous successful login.\n\nFormatted as yyyy-MM-dd'T'HH:mm:ssZ per ISO-8601.","type":"string","format":"date-time","example":"2024-05-20T09:45:00Z"},"userAccount":{"$ref":"#/components/schemas/LoginUserAccount"},"device":{"$ref":"#/components/schemas/AccountIntegrityDevice"},"eventChannel":{"$ref":"#/components/schemas/EventChannel","x-sig-needed":true},"tags":{"description":"A list of attributes or short descriptors associated with the login event.","type":"array","items":{"type":"string","example":"JULY_FACEBOOK_CAMPAIGN"}}}},"LoginResponse":{"title":"Login Response","type":"object","required":["signifydId","loginId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"loginId":{"description":"A unique ID for this login.","type":"string","example":"e33febb4-4bb7-4264-8001-504a8d7fc2d7"},"decision":{"$ref":"#/components/schemas/AccountIntegrityDecisionResponse"}}},"AccountLoginFeedbackRequest":{"title":"Account Login Feedback Request","allOf":[{"type":"object","required":["loginId"],"properties":{"loginId":{"description":"A unique ID for this login that you can use to retrieve this login event later.","type":"string","example":"e33febb4-4bb7-4264-8001-504a8d7fc2d7"},"accountId":{"description":"`needed` Your globally unique identifier for registered user accounts. Use this as the persistent user identifier,  consistent across Account Integrity APIs.","type":"string","example":"q49sgfkj49","x-sig-needed":true}}},{"$ref":"#/components/schemas/AccountFeedback"}]},"AccountLoginFeedbackResponse":{"title":"AccountLoginFeedbackResponse","type":"object","required":["signifydId","loginId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"loginId":{"description":"Login ID from the original Login event.","type":"string","example":"q49sgfkj49"}}},"Role":{"description":"The role the member will have on all underlying Teams.\n  * REVIEWER - Can view Orders. Can not perform User managment.\n  * MEMBER - Can view Orders and cancel guarantee Orders. Can not perform User managment.\n  * ADMIN - Has full rights and privileges, can view Orders and perform User managment.\n","type":"string","enum":["REVIEWER","MEMBER","ADMIN"]},"PartnerMemberResponse":{"title":"PartnerMemberResponse","type":"object","properties":{"userId":{"description":"Signifyd's unique identifier for the user.","type":"integer","format":"int64","example":123456},"role":{"$ref":"#/components/schemas/Role"}}},"PagedPartnerMembersResponse":{"title":"PagedPartnerMembersResponse","type":"object","required":["hasMore","results"],"properties":{"results":{"description":"Paged list of Partner members.","items":{"$ref":"#/components/schemas/PartnerMemberResponse"},"type":"array"},"hasMore":{"description":"Whether or not there are more members available after this page. If false, this page comprises the end of the list.","type":"boolean","example":true},"nextOffset":{"description":"If hasMore is true, you can pass this value as the offset parameter of the call to fetch the next page of members.","type":"integer","format":"int64","example":50}}},"MemberCreationRequest":{"required":["userId","role"],"title":"MemberCreationRequest","type":"object","properties":{"userId":{"description":"Signifyd's unique identifier for the user.","type":"integer","format":"int64","example":123456},"role":{"$ref":"#/components/schemas/Role"}}},"MemberUpdateRequest":{"title":"MemberUpdateRequest","type":"object","properties":{"role":{"$ref":"#/components/schemas/Role"}}},"Billing":{"description":"The billing details for the Organization","type":"object","properties":{"address":{"description":"The billing address of the Organization","allOf":[{"$ref":"#/components/schemas/Address"}]},"phoneNumber":{"description":"The billing phone number of the Organization","type":"string","format":"E.164","pattern":"^\\+[1-9]\\d{1,14}$","example":"+442892123456"},"email":{"description":"The billing email of the Organization","type":"string","format":"email","example":"billing@mycompany.com"},"billingContactGroupEmail":{"description":"The billing account alias of the Organization","type":"string","format":"email","example":"John@mycompany.com"},"primaryContactName":{"description":"The billing primary contact of the Organization","type":"string","example":"Peter"},"secondaryContactName":{"description":"The billing secondary contact of the Organization","type":"string","example":"David"}}},"Organization":{"required":["name"],"title":"Organization","type":"object","properties":{"name":{"description":"The name for the Organization.","type":"string","example":"Initrode"},"billing":{"$ref":"#/components/schemas/Billing"}}},"OrganizationResponse":{"allOf":[{"required":["orgId"],"type":"object","properties":{"orgId":{"description":"Signifyd's unique identifier for the Organization.","type":"integer","format":"int64","example":123456}}},{"$ref":"#/components/schemas/Organization"}]},"OrganizationUpdateRequest":{"title":"Organization","type":"object","properties":{"name":{"description":"The name for the Organization.","type":"string","example":"Initrode"},"billing":{"$ref":"#/components/schemas/Billing"}}},"OrganizationMemberResponse":{"title":"OrganizationMemberResponse","type":"object","properties":{"orgId":{"description":"Signifyd's unique identifier for the Organization.","type":"integer","format":"int64","example":123456},"userId":{"description":"Signifyd's unique identifier for the user.","type":"integer","format":"int64","example":123456},"role":{"$ref":"#/components/schemas/Role"}}},"PagedOrganizationMembersResponse":{"title":"PagedOrganizationMembersResponse","type":"object","required":["hasMore","results"],"properties":{"results":{"description":"Paged list of Organization members.","items":{"$ref":"#/components/schemas/OrganizationMemberResponse"},"type":"array"},"hasMore":{"description":"Whether or not there are more members available after this page. If false, this page comprises the end of the list.","type":"boolean","example":true},"nextOffset":{"description":"If hasMore is true, you can pass this value as the offset parameter of the call to fetch the next page of members.","type":"integer","format":"int64","example":50}}},"GuaranteeCoverageOptions":{"title":"GuaranteeCoverageOptions","description":"The various coverage options we want to enable for this team such as FRAUD, INR, etc.  Multiple items may be specified.\n  * `FRAUD` - Use when you need a financial guarantee for Payment Fraud.\n  * `INR` - Use when you need a financial guarantee for Item Not Received.\n  * `SNAD` - Use when you need a financial guarantee for fraud alleging items are Significantly Not As Described.\n  * `ALL` - Use when you need a financial guarantee on all chargebacks.\n","type":"array","items":{"enum":["FRAUD","INR","SNAD","ALL"]}},"ChargebackSettings":{"required":["doingBusinessAs","website","fee","currency","cbRecoveryContactEmail","claimsContactEmail","contractStartDate"],"description":"Chargeback Settings","type":"object","properties":{"fee":{"allOf":[{"description":"A basic charge that is issued in addition to any chargeback amount"},{"$ref":"#/components/schemas/Price"}]},"currency":{"allOf":[{"description":"Chargebacks fee currency."},{"$ref":"#/components/schemas/Currency"}]},"cbRecoveryContactEmail":{"description":"Contact(s) provided by the merchant for when the team needs to reach out about specific chargeback related inquiries.","type":"string","format":"email","example":"cbr.contact@mycompany.com"},"claimsContactEmail":{"description":"Claims communication email. This is the email address Signifyd will communicate with when we have questions related claims reimbursement.","type":"string","format":"email","example":"claims.contact@mycompany.com"},"contractStartDate":{"description":"When merchant signed contract date. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","type":"string","format":"date-time","example":"2023-04-05T06:07:08Z"},"guaranteeCoverageOptions":{"$ref":"#/components/schemas/GuaranteeCoverageOptions"}}},"Team":{"required":["orgId","name","website"],"title":"Team","type":"object","properties":{"orgId":{"description":"Signifyd's unique identifier for the Organization to which this Team belongs.","type":"integer","format":"int64","example":123456},"name":{"description":"The name of the Team.","type":"string","example":"Initrode East Division"},"website":{"description":"The primary domain at which the Team receives eCommerce orders.","type":"string","example":"initrode-east.com"},"chargebackSettings":{"$ref":"#/components/schemas/ChargebackSettings"},"merchantDescription":{"description":"Description of the merchant.","type":"string","example":"A retail store owner."}}},"TeamResponse":{"allOf":[{"required":["teamId"],"type":"object","properties":{"teamId":{"description":"Signifyd's unique identifier for the Team.","type":"integer","format":"int64","example":789123}}},{"$ref":"#/components/schemas/Team"}]},"Status":{"title":"Status","type":"object","properties":{"status":{"description":"Status of the team,\n  * BURN_IN - Represents a team that has recently on-boarded and is in the last stages of testing.\n      Teams in BURN_IN state receive real decisions back from Signifyd but are not billed for them.\n  * LIVE - Signifyd is billing for services.\n","type":"string","enum":["LIVE","BURN_IN"]}}},"TeamFullResponse":{"allOf":[{"$ref":"#/components/schemas/TeamResponse"},{"$ref":"#/components/schemas/Status"}]},"TeamUpdateRequest":{"title":"TeamUpdateRequest","type":"object","properties":{"name":{"description":"The name of the Team.","type":"string","example":"Initrode East Division"},"website":{"description":"The primary domain at which the Team receives eCommerce orders.","type":"string","example":"initrode-east.com"},"chargebackSettings":{"$ref":"#/components/schemas/ChargebackSettings"},"merchantDescription":{"description":"Description of the merchant.","type":"string","example":"A retail store owner."}}},"TeamStatusOnlyResponse":{"allOf":[{"required":["teamId"],"type":"object","properties":{"teamId":{"description":"Signifyd's unique identifier for the Team.","type":"integer","format":"int64","example":789123}}},{"$ref":"#/components/schemas/Status"}]},"TeamProduct":{"required":["product"],"title":"TeamProduct","type":"object","properties":{"product":{"description":"The Product offered to a Team.\n  * GFP - GUARANTEED FRAUD PROTECTION - represents a client whose orders Signifyd will guarantee and take financial liability for fraud.\n  * CBR - CHARGEBACK RECOVERY: represents a client whom signifyd will fight chargebacks for\n  * RECS - RECOMMENDATIONS: represents a client who is receiving decisions & scores.\n  * SCOR - SCORING: represents a client who is receiving only scores\n","type":"string","enum":["GFP","CBR","RECS","SCOR"]}}},"TeamProductOnlyResponse":{"allOf":[{"required":["teamId"],"type":"object","properties":{"teamId":{"description":"Signifyd's unique identifier for the Team.","type":"integer","format":"int64","example":789123}}},{"$ref":"#/components/schemas/TeamProduct"}]},"TeamMemberResponse":{"title":"TeamMemberResponse","type":"object","properties":{"teamId":{"description":"Signifyd's unique identifier for the Team.","type":"integer","format":"int64","example":123456},"userId":{"description":"Signifyd's unique identifier for the user.","type":"integer","format":"int64","example":123456},"role":{"$ref":"#/components/schemas/Role"}}},"PagedTeamMembersResponse":{"title":"PagedTeamMembersResponse","type":"object","required":["hasMore","results"],"properties":{"results":{"description":"Paged list of Team members.","items":{"$ref":"#/components/schemas/TeamMemberResponse"},"type":"array"},"hasMore":{"description":"Whether or not there are more members available after this page. If false, this page comprises the end of the list.","type":"boolean","example":true},"nextOffset":{"description":"If hasMore is true, you can pass this value as the offset parameter of the call to fetch the next page of members.","type":"integer","format":"int64","example":50}}},"UserCreation":{"title":"UserCreation","type":"object","required":["email"],"properties":{"userId":{"description":"Signifyd's unique identifier for the user.","type":"integer","format":"int64","example":123456,"readOnly":true},"email":{"description":"Email of the user. This will be used as a unique identifier for the user and is essentially the user's username. It can be used to access the [Signifyd Console](http://app.signifyd.com). When a user is first created they will be sent an email to confirm their email address and set up a password.","type":"string","format":"email","example":"user@mycompany.com"}}},"ChargebackId":{"description":"Unique Chargeback id as given by payment processor or merchant. Maximum length of 256 characters.","example":"MyChargeback-1234","type":"string"},"PartnerChargebackId":{"description":"Optional field containing a unique Id generated within a partner's system to represent a chargeback case.","example":"PB5CDVPNB6X","type":"string"},"PartnerMerchantId":{"description":"Partner system's unique identifier for the merchant. Optional.","example":"ABC123","type":"string"},"ChargebackPrice":{"type":"number","format":"double","minimum":0,"exclusiveMinimum":true,"example":9.99},"ChargebackCurrency":{"type":"string","format":"ISO-4217-Alpha","minLength":3,"maxLength":3,"default":"USD"},"ChargebackAmount":{"description":"The amount of the transaction and the currency it is within.","properties":{"amount":{"description":"`needed` The amount of the transaction. This must be greater than zero and less than or equal to the original order amount.","x-sig-needed":true,"allOf":[{"$ref":"#/components/schemas/ChargebackPrice"}]},"currencyCode":{"description":"`needed` The ISO 4217 code for the currency.","x-sig-needed":true,"allOf":[{"$ref":"#/components/schemas/ChargebackCurrency"}]}},"title":"ChargebackAmount","type":"object"},"CreateChargebackReason":{"description":"`needed` A Payment Processor's view of the reason for the chargeback.\n","properties":{"processorName":{"description":"Payment processor (e.g. WORLDPAY, ADYEN, PAYPAL etc.).","example":"WORLDPAY","type":"string","x-sig-needed":true},"processorReasonCode":{"description":"`needed` Reason code issued by payment processor.\n","example":"81","type":"string"},"processorReasonDescription":{"description":"`needed` Detailed reason description issued by payment processor.\n","example":"Fraud","type":"string","x-sig-needed":true}},"title":"CreateChargebackReason","type":"object","x-sig-needed":true},"ChargebackFeeAmount":{"description":"The fee charged by the payment processor for handling a transaction dispute. It is applied per chargeback regardless of the outcome.","properties":{"amount":{"description":"`needed` The monetary value of the chargeback fee applied by the payment processor for handling the dispute. The fee is capped at 30 USD (or the equivalent in the settlement currency).\n","example":12.34,"x-sig-needed":true,"allOf":[{"$ref":"#/components/schemas/Price"}]},"currencyCode":{"description":"`needed` The ISO 4217 code for the currency.\n","example":"USD","x-sig-needed":true,"allOf":[{"$ref":"#/components/schemas/ChargebackCurrency"}]}},"title":"ChargebackFeeAmount","type":"object"},"CreateSetChargebackStage":{"enum":["RETRIEVAL","CHARGEBACK"],"title":"CreateSetChargebackStage","type":"string","description":"`needed` The Chargeback Stage refers to the stage within the chargeback dispute lifecycle that the chargeback is in with respect to the payment processor/gateway. <br />\n\n * `RETRIEVAL` - To be used when the issuer or the cardholder requests additional information regarding a charge on their card before they request for a credit and it is converted into a chargeback. There is no financial adjustment made at this stage.\n * `CHARGEBACK` - To be used when the issuing bank initiates the first chargeback on behalf of the cardholder by sending a chargeback notification stating the dispute reason.\n   * More information: <a href=\"https://www.signifyd.com/resources/fraud-101/chargeback-process-in-depth/#firstChargeback\" > First Chargeback </a>\n","x-sig-needed":true},"AssumedOwner":{"enum":["SIGNIFYD","EXTERNAL"],"example":"SIGNIFYD","title":"AssumedOwner","type":"string","description":"AssumedOwner is required when setting AssumedOwnership. This field is passed to Signifyd to indicate  the assumed owning party of the representation rights upon creation of the chargeback case. <br />\n * `SIGNIFYD` - Signifyd is the assumed owner of the chargeback's representation rights.\n * `EXTERNAL` - The merchant (or authorized 3rd party) is the assumed owner of the chargeback's representation rights."},"AssumedOwnership":{"properties":{"assumedOwner":{"$ref":"#/components/schemas/AssumedOwner"}},"title":"AssumedOwnership","type":"object","required":["assumedOwner"],"description":"Assumed ownership is an optional field passed to Signifyd to provide details about the assumed owning party of the  representation rights upon creation of the chargeback case. This field will be ignored unless the caller is a Signifyd partner."},"ChargebackCreateRequest":{"properties":{"amount":{"$ref":"#/components/schemas/ChargebackAmount"},"reason":{"$ref":"#/components/schemas/CreateChargebackReason"},"cardholderEmail":{"description":"Card holder's email.","example":"example@email.com","type":"string","format":"email"},"cardholderName":{"description":"Card holder's name.","example":"Example-Name","type":"string"},"chargebackFees":{"$ref":"#/components/schemas/ChargebackFeeAmount"},"issuerReportedDate":{"description":"`needed` The date on which the issuer reported creation of the chargeback. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)","x-sig-needed":true,"allOf":[{"$ref":"#/components/schemas/DateTime"}]},"dueDate":{"description":"`needed` The date by which a response to the chargeback is required. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)","allOf":[{"$ref":"#/components/schemas/DateTime"}],"x-sig-needed":true},"paymentProcessor":{"description":"`needed` Payment processor (e.g. WORLDPAY, ADYEN, PAYPAL etc.).\n","example":"WORLDPAY","type":"string","x-sig-needed":true},"paymentNetwork":{"description":"`needed` Payment network (e.g. Visa, Mastercard, etc.).\n","example":"Visa","type":"string","x-sig-needed":true},"chargebackStage":{"$ref":"#/components/schemas/CreateSetChargebackStage"},"assumedOwnership":{"$ref":"#/components/schemas/AssumedOwnership"}},"required":["amount"],"title":"ChargebackCreateRequest","type":"object"},"FulfillmentMethod":{"enum":["DELIVERY","COUNTER_PICKUP","CURBSIDE_PICKUP","LOCKER_PICKUP","STANDARD_SHIPPING","EXPEDITED_SHIPPING","GAS_PICKUP","SCHEDULED_DELIVERY","TWO_DAY_SHIPPING","OVERNIGHT_SHIPPING","FREIGHT_SHIPPING","SAME_DAY_DELIVERY"],"example":"DELIVERY","title":"FulfillmentMethod","type":"string","description":"`needed` The Fulfillment Method refers to the method of fulfillment for the order. <br/>\n\n * `DELIVERY`\n * `COUNTER_PICKUP`\n * `CURBSIDE_PICKUP`\n * `LOCKER_PICKUP`\n * `STANDARD_SHIPPING`\n * `EXPEDITED_SHIPPING`\n * `GAS_PICKUP`\n * `SCHEDULED_DELIVERY`\n * `TWO_DAY_SHIPPING`\n * `OVERNIGHT_SHIPPING`\n * `FREIGHT_SHIPPING`\n * `SAME_DAY_DELIVERY`"},"FulfillmentDetail":{"properties":{"shipper":{"description":"`needed` The shipper's name.\n","example":"UPS","type":"string","x-sig-needed":true},"trackingNumber":{"description":"`needed` The order's tracking number.\n","example":"1111111","type":"string","x-sig-needed":true},"fulfillmentMethod":{"$ref":"#/components/schemas/FulfillmentMethod"}},"title":"FulfillmentDetail","type":"object"},"ChargebackRequest":{"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"chargebackId":{"$ref":"#/components/schemas/ChargebackId"},"partnerChargebackId":{"$ref":"#/components/schemas/PartnerChargebackId"},"partnerMerchantId":{"$ref":"#/components/schemas/PartnerMerchantId"},"chargeback":{"$ref":"#/components/schemas/ChargebackCreateRequest"},"fulfillments":{"description":"This object is not required if the Fulfillments API endpoint has been used.","items":{"$ref":"#/components/schemas/FulfillmentDetail"},"type":"array"}},"required":["orderId","chargebackId","chargeback"],"title":"ChargebackRequest","type":"object"},"ChargebackStage":{"enum":["ARBITRATION","CHARGEBACK","PREARBITRATION","RETRIEVAL","RECALLED"],"title":"ChargebackStage","type":"string","description":"The Chargeback Stage refers to the stage within the chargeback dispute lifecycle that the chargeback is in with respect to the payment processor/gateway. <br />\n\n * `RETRIEVAL` - This indicates the issuer or the cardholder has requested additional information regarding a charge on their card before they request for a credit and it is converted into a chargeback. There is no financial adjustment made at this stage.\n * `CHARGEBACK` - This indicates an issuing bank has initiated the first chargeback on behalf of the cardholder by sending a chargeback notification stating the dispute reason.\n   * More information: <a href=\"https://www.signifyd.com/resources/fraud-101/chargeback-process-in-depth/#firstChargeback\" > First Chargeback </a>\n * `PREARBITRATION` - A pre-arb (pre-arbitration) is a second chargeback. This indicates the merchant has challenged the chargeback and the bank initially ruled in the merchant's favor, the cardholder can raise a second chargeback.\n   * More information: <a href=\"https://www.signifyd.com/resources/fraud-101/chargeback-process-in-depth/#secondChargeback\" > Pre-Arbitration</a>\n * `ARBITRATION` - The final step that a merchant may encounter in the chargeback process is called arbitration. Arbitration involves the relevant card association stepping in to help resolve the dispute between the acquiring and issuing banks, and by extension the merchant and the cardholder.\n   * More information: <a href=\"https://www.signifyd.com/resources/fraud-101/chargeback-process-in-depth/#arbitration\" > Arbitration </a>\n * `RECALLED` - To be used when the issuer or the cardholder recalls the chargeback. There are no adjustments to chargeback details made at this stage."},"ChargebackSummary":{"properties":{"signifydChargebackId":{"description":"Signifyd's unique identifier of the chargeback.","example":987,"type":"integer","format":"int64"},"chargebackId":{"$ref":"#/components/schemas/ChargebackId"},"stage":{"$ref":"#/components/schemas/ChargebackStage"}},"required":["chargebackId","signifydChargebackId","stage"],"title":"ChargebackSummary","type":"object"},"ClaimDisposition":{"enum":["APPROVED","DECLINED"],"title":"ClaimDisposition","type":"string","description":"This indicates whether a merchant's chargeback qualifies for reimbursement from Signifyd. <br />\n\n * `APPROVED` - This indicates that the merchant was able to meet all claim requirements and the request for reimbursement has been approved.\n * `DECLINED` - This indicates that the merchant was not able to meet all claim requirements and the request for reimbursement has been declined."},"ClaimDispositionReason":{"enum":["INELIGIBLE_CHARGEBACK","PRODUCT_REROUTED","PRODUCT_RETURNED","ORDER_NOT_GUARANTEED","MISSING_INFORMATION","PAST_ELIGIBLE_SUBMISSION_DATE","NOT_A_CHARGEBACK","UNABLE_TO_VERIFY_PROOF_OF_SHIPMENT","HISTORICAL_INGESTION","AUTO_DISPOSITION","DEPRECATED_REASON","INELIGIBLE_PRE_AUTH_GATEWAY_STATUS_CODE"],"title":"ClaimDispositionReason","type":"string","description":"The Disposition Reason provides additional context to the disposition result. <br />\n\n * `INELIGIBLE_CHARGEBACK` - This indicates that the chargeback reason that the merchant submitted for reimbursement is not eligible under their coverage.\n * `PRODUCT_REROUTED` - This indicates that the merchandise was delivered to an address that is different from the address associated with the guaranteed order.\n * `PRODUCT_RETURNED` - This indicates that the merchandise was returned or is in the process of being returned to the merchant.\n * `ORDER_NOT_GUARANTEED` - This indicates that the guarantee disposition is not approved.\n * `MISSING_INFORMATION` - This indicates that the claim was declined after 30 days of being in NEED_MORE_INFO status and the merchant has not responded with the information requested in order to disposition their claim.\n * `PAST_ELIGIBLE_SUBMISSION_DATE` - This indicates that the chargeback was not submitted within 7 days of receiving the notice from the payment processor.\n * `NOT_A_CHARGEBACK` - This indicates that the claim submitted was not for a chargeback but rather a retrieval request/inquiry or other losses that the merchant incurred, which are not covered by Signifyd's Guarantee Services.\n * `UNABLE_TO_VERIFY_PROOF_OF_SHIPMENT` - This indicates that a valid tracking number for the merchandise has not been provided.\n * `HISTORICAL_INGESTION` - This indicates that the chargeback has been created via historical ingestion and is not eligible for reimbursement.\n * `AUTO_DISPOSITION` - This indicates that a claim was processed via auto dispositioning.\n * `DEPRECATED_REASON` - This indicates that a disposition reason was derived which has since been deprecated.\n * `INELIGIBLE_PRE_AUTH_GATEWAY_STATUS_CODE` - This indicates that a chargeback has an investigation processing policy of pre auth and a non-success gateway status code."},"ClaimStatus":{"enum":["PENDING","NEED_MORE_INFO","CANCELLED","CLOSED"],"example":"CLOSED","title":"ClaimStatus","type":"string","description":"The Claim Status refers to the status within the Signifyd claim lifecycle that the claim is in. <br />\n\n * `PENDING` - This indicates that a claim is still pending disposition.\n * `NEED_MORE_INFO` - This indicates that that claim cannot be dispositioned because there is a missing requirement or insufficient information.\n * `CANCELLED` - This indicates that the claim was requested to be cancelled by the merchant or the PSP. Signifyd may also cancel a claim if a duplicate was created/submitted in error.\n * `CLOSED` - This indicates that the claim has been dispositioned as APPROVED or DECLINED."},"ClaimSummary":{"properties":{"signifydClaimId":{"description":"Signifyd's unique identifier of this Claim.","example":12345,"type":"integer","format":"int64"},"disposition":{"$ref":"#/components/schemas/ClaimDisposition"},"dispositionReason":{"$ref":"#/components/schemas/ClaimDispositionReason"},"status":{"$ref":"#/components/schemas/ClaimStatus"}},"required":["claimId","status"],"title":"ClaimSummary","type":"object"},"RepresentmentOutcome":{"enum":["NONE","LOST","WON"],"example":"LOST","title":"RepresentmentOutcome","type":"string","description":"The Representment Outcome indicates the final result of the representment case. <br />\n\n * `NONE` - This indicates that the chargeback was disputed but the outcome is not available, cannot be obtained or was not received.\n * `LOST` - This indicates that the chargeback was resolved in favor of the cardholder.\n * `WON` - This indicates that the chargeback was resolved in favor of the merchant."},"RepresentmentStatus":{"enum":["IN_PROGRESS","DISPUTED","ABANDONED","CLOSED"],"example":"CLOSED","title":"RepresentmentStatus","type":"string","description":"The Representment Status refers to the status within the Signifyd claim lifecycle that the representment is in. <br />\nNote: If a chargeback enters a new stage, the Representment Status will automatically go back to the IN_PROGRESS. <br />\n\n * `IN_PROGRESS` - This indicates that a representment is still pending outcome.\n   * Note: If a chargeback enters a new stage, the Representment Status will automatically go back to IN_PROGRESS.\n * `DISPUTED` - This indicates that the chargeback was represented and is pending representment.\n * `ABANDONED` - This indicates that the case is abandoned due to not being able to represent the chargeback.\n * `CLOSED` - This indicates that the chargeback was represented and an outcome was received either in favor of the merchant or the cardholder. Alternatively, no outcome was received after the entire chargeback cycle has passed."},"RepresentmentSummary":{"properties":{"signifydRepresentmentId":{"description":"Signifyd's unique identifier of this Representment. Should match the parent Chargeback Id.","example":987,"type":"number"},"outcome":{"$ref":"#/components/schemas/RepresentmentOutcome"},"status":{"$ref":"#/components/schemas/RepresentmentStatus"}},"required":["representmentId","status"],"title":"RepresentmentSummary","type":"object"},"ChargebackCaseSummary":{"properties":{"chargebackSummary":{"description":"Summary of the Chargeback.","$ref":"#/components/schemas/ChargebackSummary"},"claimSummary":{"description":"Summary of the current status of the Claim. It will also include Disposition details, if they exist.","$ref":"#/components/schemas/ClaimSummary"},"representmentSummary":{"description":"Summary of the current status of the Representment. It will also include Outcome details, if they exist.","$ref":"#/components/schemas/RepresentmentSummary"}},"required":["chargebackSummary","claimSummary"],"title":"ChargebackCaseSummary","type":"object"},"ChargebackCaseResponse":{"properties":{"orderId":{"description":"Unique Order identifier as given by merchant.","example":"XGR-1840823423","type":"string"},"signifydId":{"description":"The unique identifier for the investigation, within Signifyd, that the chargeback is linked to.","example":999999,"type":"integer","format":"int64"},"chargebackCaseSummary":{"description":"","$ref":"#/components/schemas/ChargebackCaseSummary"}},"required":["orderId","signifydId","chargebackCaseSummary"],"title":"ChargebackCaseResponse","type":"object"},"UpdateRepresentmentOutcome":{"enum":["LOST","WON"],"title":"UpdateRepresentmentOutcome","type":"string","description":"The Representment Outcome indicates the final result of the representment case. <br />\n\n * `LOST` - To be used when the chargeback was resolved in favor of the cardholder.\n * `WON` - To be used when the chargeback was resolved in favor of the merchant."},"ChargebackUpdateOutcomeRequest":{"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"chargebackId":{"$ref":"#/components/schemas/ChargebackId"},"partnerChargebackId":{"$ref":"#/components/schemas/PartnerChargebackId"},"representmentOutcome":{"$ref":"#/components/schemas/UpdateRepresentmentOutcome"}},"required":["orderId","chargebackId","representmentOutcome"],"title":"ChargebackUpdateOutcomeRequest","type":"object"},"UpdateChargebackStage":{"enum":["RETRIEVAL","CHARGEBACK","PREARBITRATION","ARBITRATION","RECALLED"],"title":"ChargebackStage","type":"string","description":"The Chargeback Stage refers to the stage within the chargeback dispute lifecycle that the chargeback is in with respect to the payment processor/gateway. <br />\n\n * `RETRIEVAL` - To be used when the issuer or the cardholder requests additional information regarding a charge on their card before they request for a credit and it is converted into a chargeback. There is no financial adjustment made at this stage.\n * `CHARGEBACK` - To be used when the issuing bank initiates the first chargeback on behalf of the cardholder by sending a chargeback notification stating the dispute reason.\n   * More information: <a href=\"https://www.signifyd.com/resources/fraud-101/chargeback-process-in-depth/#firstChargeback\" > First Chargeback </a>\n * `PREARBITRATION` - A pre-arb (pre-arbitration) is a second chargeback. To be used when the merchant challenges the chargeback and the bank initially rules in the merchant's favor, the cardholder can raise a second chargeback.\n   * More information: <a href=\"https://www.signifyd.com/resources/fraud-101/chargeback-process-in-depth/#secondChargeback\" > Pre-Arbitration</a>\n * `ARBITRATION` - The final step that a merchant may encounter in the chargeback process is called arbitration. Arbitration involves the relevant card association stepping in to help resolve the dispute between the acquiring and issuing banks, and by extension the merchant and the cardholder.\n   * More information: <a href=\"https://www.signifyd.com/resources/fraud-101/chargeback-process-in-depth/#arbitration\" > Arbitration </a>\n * `RECALLED` - To be used when the issuer or the cardholder recalls the chargeback. There are no adjustments to chargeback details made at this stage."},"ChargebackReason":{"description":"A Payment Processor's view of the reason for the chargeback.","properties":{"processorName":{"description":"Payment processor (e.g. WORLDPAY, ADYEN, PAYPAL etc.).","example":"WORLDPAY","type":"string"},"processorReasonCode":{"description":"Reason code issued by payment processor.","example":"81","type":"string"},"processorReasonDescription":{"description":"Detailed reason description issued by payment processor.","example":"Fraud","type":"string"}},"title":"ChargebackReason","type":"object"},"UpdateRepresentmentOutcomeWithStage":{"enum":["NONE","LOST","WON"],"title":"UpdateRepresentmentOutcome","type":"string","description":"The Representment Outcome indicates the final result of the representment case. <br />\n\n * `NONE` - To be used when the chargeback was disputed but the outcome is not available, cannot be obtained or was not received.\n * `LOST` - To be used when the chargeback was resolved in favor of the cardholder.\n * `WON` - To be used when the chargeback was resolved in favor of the merchant."},"ChargebackUpdateStageRequest":{"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"chargebackId":{"$ref":"#/components/schemas/ChargebackId"},"partnerChargebackId":{"$ref":"#/components/schemas/PartnerChargebackId"},"chargebackStage":{"$ref":"#/components/schemas/UpdateChargebackStage"},"changeAmount":{"$ref":"#/components/schemas/ChargebackAmount"},"changeReason":{"$ref":"#/components/schemas/ChargebackReason"},"changeRepresentmentOutcome":{"$ref":"#/components/schemas/UpdateRepresentmentOutcomeWithStage"},"issuerReportedDate":{"description":"The date on which the issuer reported updating the chargeback stage. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)","allOf":[{"$ref":"#/components/schemas/DateTime"}]},"dueDate":{"description":"The date by which a response to the new chargeback stage is required. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)","allOf":[{"$ref":"#/components/schemas/DateTime"}]},"assumedOwnership":{"$ref":"#/components/schemas/AssumedOwnership"}},"required":["orderId","chargebackId","chargebackStage"],"title":"ChargebackUpdateStageRequest","type":"object"},"AlertProviderReferenceId":{"description":"Unique reference associated with the early alert by the provider and maintained throughout the life cycle of the transaction.","example":"BPXQX21TJ18WORG8","type":"string"},"Amount":{"description":"The amount of the transaction and the currency it is within.","properties":{"amount":{"description":"The amount of the transaction. This must be greater than zero and less than or equal to the original order amount.","allOf":[{"$ref":"#/components/schemas/Price"}]},"currencyCode":{"description":"The ISO 4217 code for the currency.","allOf":[{"$ref":"#/components/schemas/Currency"}]}},"title":"Amount","type":"object"},"CardBin":{"description":"Card Bank Identification Number","example":400344,"type":"integer"},"MerchantName":{"description":"Name of the merchant associated with this early alert","example":"Samsung","type":"string"},"AlertName":{"description":"Provider’s name for the early alert.","example":"NOTIFICATION_OF_FRAUD","type":"string"},"AlertInitiatedBy":{"enum":["ISSUER","CARDHOLDER","NOT_AVAILABLE"],"example":"CARDHOLDER","title":"AlertInitiatedBy","type":"string","description":"Whether the transaction was initially identified by the card holder or the card issuer. <br />\n * `ISSUER` - This indicates that an alert was initiated by the issuer.\n * `CARDHOLDER` - This indicates that an alert was initiated by the cardholder.\n * `NOT_AVAILABLE` - When the initiator is unknown or unavailable."},"CardholderEmail":{"description":"Email address for the cardholder","example":"name@example.com","type":"string"},"CardholderName":{"description":"Name associated with the cardholder","example":"John Smith","type":"string"},"MerchantId":{"description":"The merchant account identifier used in the transaction the alert is for.","example":"SomeCompany_ECom","type":"string"},"MerchantCategoryCode":{"description":"A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. An MCC is used to classify every business that accepts card payments by the goods or services it provides. The MCC is provided by payment processors on authorizations.","type":"string","format":"ISO-18245","example":"1111"},"CardScheme":{"description":"Card scheme linked to payment card","example":"visa","type":"string"},"Issuer":{"description":"The name of the card issuer","example":"Capital One","type":"string"},"TransactionId":{"description":"Unique value assigned by the card scheme (VISA/Mastercard, etc.) to each transaction on the Authorization and maintained throughout the life cycle of the transaction.","example":"A9Y2X01TI18POAG7","type":"string"},"Arn":{"description":"Acquirer Reference Number assigned to the transaction","example":"arn1665059145275","type":"string"},"AlertReasonCode":{"description":"The card scheme-specific chargeback reason code which indicates the cardholder’s reason for disputing the transaction.","example":"A","type":"string"},"AlertReasonDescription":{"description":"Description of the alert reason","example":"Fraudulent Use of Account Number","type":"string"},"AlertOutcome":{"description":"The outcome for the alert.","example":"RESOLVED","type":"string"},"EarlyAlertRequest":{"properties":{"alertProviderReferenceId":{"$ref":"#/components/schemas/AlertProviderReferenceId"},"amount":{"$ref":"#/components/schemas/Amount"},"cardBin":{"$ref":"#/components/schemas/CardBin"},"merchantName":{"$ref":"#/components/schemas/MerchantName"},"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"alertName":{"$ref":"#/components/schemas/AlertName"},"alertProviderReportedDate":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"description":"The date on which the early alert was reported by the provider. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` per [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)"}]},"alertInitiatedBy":{"$ref":"#/components/schemas/AlertInitiatedBy"},"cardholderEmail":{"$ref":"#/components/schemas/CardholderEmail"},"cardholderName":{"$ref":"#/components/schemas/CardholderName"},"merchantId":{"$ref":"#/components/schemas/MerchantId"},"mcc":{"$ref":"#/components/schemas/MerchantCategoryCode"},"cardScheme":{"$ref":"#/components/schemas/CardScheme"},"issuer":{"$ref":"#/components/schemas/Issuer"},"transactionId":{"$ref":"#/components/schemas/TransactionId"},"arn":{"$ref":"#/components/schemas/Arn"},"alertReasonCode":{"$ref":"#/components/schemas/AlertReasonCode"},"alertReasonDescription":{"$ref":"#/components/schemas/AlertReasonDescription"},"alertOutcome":{"$ref":"#/components/schemas/AlertOutcome"}},"required":["alertProviderReferenceId","amount","cardBin","merchantName","orderId"],"title":"EarlyAlertRequest","type":"object"},"EarlyAlertResponse":{"properties":{"orderId":{"description":"Unique Order identifier as given by merchant.","example":"XGR-1840823423","type":"string"},"signifydId":{"description":"Unique identifier for the investigation, within Signifyd, that the early alert is linked to. Only present if the early alert was successfully matched to an internal Signifyd investigation.","example":999999,"type":"integer","format":"int64"}},"required":["orderId"],"title":"EarlyAlertResponse","type":"object"},"CheckoutId":{"type":"string","description":"Unique identifier for a checkout.","example":"29bd5784-d3e0-4baa-bd2f-dbb82d90406d"},"MerchantPlatform":{"title":"MerchantPlatform","type":"object","description":"Details about the merchant's commerce platform.","properties":{"name":{"type":"string","description":"`needed` The name of the merchant's commerce platform.","x-sig-needed":true,"example":"Salesforce Commerce Cloud"},"version":{"type":"string","description":"`needed` The version of the merchant's commerce platform.","x-sig-needed":true,"example":"1.2.4"}}},"SignifydClient":{"title":"SignifydClient","type":"object","description":"For internal use only. Provides Signifyd details about the Signifyd plugin that a merchant is using.","properties":{"application":{"type":"string","description":"The Signifyd plugin that the merchant is using.","example":"Salesforce Commerce Cloud"},"version":{"type":"string","description":"The version of the Signifyd plugin that is being used.","example":"18.1.0"}}},"GenericPaymentDetails":{"title":"GenericPaymentDetails","type":"object","properties":{"billingAddress":{"$ref":"#/components/schemas/Address"},"accountHolderName":{"description":"`needed` The full name of the account holder as provided during checkout.","type":"string","x-sig-needed":true,"example":"Michael Scott"},"accountHolderTaxId":{"description":"The unique taxpayer identifier for the account user. Due to legal restrictions, the values currently accepted here are Brazilian CPF, Brazilian CNPJ, Chilean RUT, Argentinian DNI, Colombian CC, Costa Ricans Cédula de identidad, Guatemalan DPI and Peruvian DNI numbers.","type":"string","example":"231.002.999-00"},"accountHolderTaxIdCountry":{"description":"The country that issued the userAccountTaxId. Due to legal restrictions, the values currently accepted here are AR, BR, CL, CO, CR, GT and PE.","type":"string","format":"ISO-3166-1-alpha-2","minLength":2,"maxLength":2,"example":"BR"},"accountLast4":{"description":"The last 4 digits of the bank account number as provided during checkout.","type":"string","example":"2548","minLength":4,"maxLength":4},"abaRoutingNumber":{"description":"The routing number (ABA) of the bank account that was used as provided during checkout.","type":"string","example":"121122676","minLength":9,"maxLength":9},"bankRoutingNumber":{"description":"The routing number of the non-US bank account that was used for this transaction, such as a SWIFT code. If a US bank account, please use `abaRoutingNumber`.","type":"string","maxLength":64,"example":null,"nullable":true},"bankRoutingCountry":{"description":"The country of origin of the bank account that was used for this transaction. Country must be provided along with `bankRoutingNumber`. If you send a US ABA Number, this field is not required.","type":"string","example":null,"format":"ISO-3166-1-alpha-2","minLength":2,"maxLength":2,"nullable":true},"cardToken":{"description":"A unique string value as provided by the `cardTokenProvider` which replaces the card Primary Account Number (PAN). The same `cardToken` from the same `cardTokenProvider` should never be from two different PANs.\n\nSignifyd stores all cardToken values in a fully PCI-compliant way. The cardToken field and any values are redacted from all user interface elements (such as Developer Tools) and will not be shown.\n","type":"string","example":"oTktJmBaAhUyGHnNJt7WMA"},"cardTokenProvider":{"description":"The issuer of the `cardToken`, that is, whomever generated the `cardToken` originally. If your tokenization provider isn't listed, please reach out to our Implementations team.\n\n* `EMV_NETWORK` - if the token is an [EMVCo Network Token](https://www.emvco.com/emv-technologies/payment-tokenisation/) * `FISERV` - if the token was issued by Fiserv. * `MERCHANT` - if the merchant themselves generated the token. * `SIGNIFYD` - if the token was issued by the Signifyd Tokenization Service. * `VGS` - if the token was issued by [Very Good Security](https://www.verygoodsecurity.com/). * `CHASE` - if the token was issued by Chase. * `BLUESNAP` - if the token was issued by [BlueSnap](https://developers.bluesnap.com/docs/completing-tokenized-payments). * `SPREEDLY` - if the token was provided by Spreedly. * `PAYMETRIC` - if the token was provided by Paymetric. * `STRIPE` - if the token was provided by Stripe. * `CYBERSOURCE` - if the token was provided by Cybersource.\n","type":"string","enum":["EMV_NETWORK","FISERV","MERCHANT","SIGNIFYD","VGS","CHASE","BLUESNAP","SPREEDLY","PAYMETRIC","STRIPE","CYBERSOURCE"],"example":"MERCHANT"},"cardBin":{"description":"`needed` The first six or eight digits of the credit card, the bank identification number, which uniquely identifies the issuer as provided during checkout.","type":"string","x-sig-needed":true,"pattern":"^(\\d{6}|\\d{8})$","example":"441104"},"cardExpiryMonth":{"description":"`needed` Month representation of the expiration month of the credit card as provided during checkout.","type":"integer","x-sig-needed":true,"minimum":1,"maximum":12,"example":3},"cardExpiryYear":{"description":"`needed` yyyy representation of the expiration year of the credit card as provided during checkout.","type":"integer","x-sig-needed":true,"minimum":1946,"maximum":2100,"example":2022},"cardLast4":{"description":"`needed` The last four digits of the credit card number as provided during checkout.","type":"string","x-sig-needed":true,"minLength":4,"maxLength":4,"example":"0215"},"cardBrand":{"type":"string","description":"The name of the card brand, e.g. Visa or Mastercard.  Note, it is preferred that you provide a `cardBin` rather than providing this field directly.\n\nIf using a co-branded card, if unbranded pass the merchant name else use the card brand that was selected at checkout eg., VISA, AMEX.\n\nAny value will be accepted, but we strongly recommend mapping to one of the following keys if possible. Please reach out to our implementations team if you believe there is an important key missing.\n\n\n  * `AMEX`\n  * `DANKORT`\n  * `DINERS_CLUB`\n  * `DISCOVER`\n  * `ELO`\n  * `FORBRUGSFORENINGEN`\n  * `HIPERCARD`\n  * `JCB`\n  * `MAESTRO`\n  * `MASTERCARD`\n  * `UNIONPAY`\n  * `VISA`\n","example":"VISA"},"cardFunding":{"description":"The funding methodology of the card.  Note, it is preferred that you provide a `cardBin` rather than providing this field directly. If you are providing `cardBin` there is no need to populate this field. Any value will be accepted, but we strongly recommend mapping to one of the following keys if possible. Please reach out to our Implementations team if you believe there is an important key missing.\n  * `CREDIT` - if it is a Credit Card.\n  * `DEBIT` - if it is a Debit Card.\n  * `PREPAID` - if it is a stored value, aka Pre-paid, Card.\n  * `SNAP` - if it is a card funded by the Supplemental Nutrition Assistance Program.\n","type":"string","example":"CREDIT"},"cardInstallments":{"description":"Installments is a feature of consumer credit cards in some markets (known as meses sin intereses in Mexico) that allows customers to split purchases over multiple billing statements. Use the 'cardInstallments' object to provide details of the installment plan. When using cardInstallments the 'amount' value for the transaction should be equal to the charge for the first installment + any fees you charge instead of the value of the entire order.\n\nNote: Signifyd expects to receive installment payments from Mexico, Brazil, Argentina. Chile, Colombia and Uruguay.\n","type":"object","title":"Installment","properties":{"interval":{"description":"The period in which the installment plan will be paid.","type":"string","enum":["Month"],"example":"Month"},"count":{"description":"The total number of payments expected to be made on the installment plan","type":"integer","example":4},"totalValue":{"description":"The total value of the installment plan","type":"number","format":"decimal","example":25},"installmentValue":{"description":"The expected payment value for each installment.","type":"number","format":"decimal","example":25}}}}},"PaymentInstrument":{"title":"PaymentInstrument","type":"object","properties":{"accountNumber":{"description":"The last four digits of the payment account.","type":"string","example":"42202452-dq3"},"active":{"description":"Denotes whether the account is able to transact.","type":"boolean","example":true},"verified":{"description":"Denote whether the account holder's identity was verified by the institution or payment provider.","type":"boolean","example":true},"assetBalance":{"description":"The net asset balance on the account.  If this is a stored value account, like a checking account, then this amount should be positive.  If this is a loan account, like a credit card, then this amount should be negative.","example":-10785.23,"type":"number","format":"double"},"creditLimit":{"description":"The maximum amount of credit that this account may incur.  This should correspond to the lowest possible value for the `balance`.  For example, if the value here is `20000`, then  the `balance` field should be able to go as low as `-20000`.","type":"number","format":"double"},"createdAt":{"description":"The date the payment account was created. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2019-12-21T13:57:40-07:00","type":"string","format":"date-time"},"ownerAnnualIncome":{"description":"The annual income of the account owner.","type":"number","example":50000},"ownerDob":{"type":"string","format":"date","description":"The date of birth of the account owner.","example":"1980-05-20"},"ownerName":{"description":"The full name of the account owner.","type":"string","example":"Michael Scott"},"contactEmail":{"description":"The email listed on the account for contacting the account owner.","type":"string","example":"mgscottdmp1980@gmail.com"},"contactPhone":{"description":"The phone number listed on the account for contacting the account owner.","type":"string","example":"+442071838750"},"contactAddress":{"title":"Address","allOf":[{"$ref":"#/components/schemas/Address"},{"description":"The physical address listed on the account for contacting the account owner."}]}}},"AcquirerDetails":{"title":"AcquirerDetails","type":"object","nullable":true,"description":"Details about the merchant's acquiring bank. Although this information is optional, if it is not present it may result in missed SCA exemptions/exclusions.\n","properties":{"countryCode":{"description":"The two-letter ISO-3166 country code of the acquiring bank.","type":"string","format":"ISO-3166-1-alpha-2","minLength":2,"maxLength":2,"nullable":true,"example":"GB"},"bin":{"description":"The bank identification number for the merchant's acquiring bank.","type":"string","pattern":"^(\\d{6}|\\d{8})$","nullable":true,"example":"441104"}}},"AdditionalPreAuthProperties":{"required":["amount","currency"],"properties":{"amount":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"The amount that was charged to the payment instrument.","example":105.99,"type":"number"}]},"currency":{"allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"The currency in which the `amount` is denominated.","example":"USD","type":"string"}]},"gateway":{"description":"`needed` The name of the payment gateway or financial institution that processed the transaction.","type":"string","x-sig-needed":true,"example":"braintree"},"sourceAccountDetails":{"allOf":[{"$ref":"#/components/schemas/PaymentInstrument"},{"description":"These are details about the Payment Instrument that are sourced directly from the institution that manages that instrument, the issuing bank for example.  It is atypical for a merchant to have these details."}]},"acquirerDetails":{"$ref":"#/components/schemas/AcquirerDetails"}}},"PreAuthCardTransaction":{"title":"PreAuthCardTransaction","required":["paymentMethod"],"allOf":[{"properties":{"paymentMethod":{"type":"string","description":"The name of the Payment Method. Any name will be accepted, but we strongly recommend mapping to one of the following keys if possible:\n  * `CREDIT_CARD`\n  * `GIFT_CARD`\n  * `DEBIT_CARD`\n  * `PREPAID_CARD`\n  * `SNAP_CARD`\n  * `CLICK_TO_PAY`","example":"CREDIT_CARD"}}},{"properties":{"checkoutPaymentDetails":{"$ref":"#/components/schemas/GenericPaymentDetails"}}},{"$ref":"#/components/schemas/AdditionalPreAuthProperties"}]},"PreAuthBankTransaction":{"title":"PreAuthBankTransaction","required":["paymentMethod"],"allOf":[{"properties":{"paymentMethod":{"type":"string","description":"The name of the Payment Method. Any name will be accepted, but we strongly recommend mapping to one of the following keys if possible:\n  * `ACH`\n  * `iDeal`\n  * `FAST Payments`\n  * `SPEI`\n  * `PIX`\n  * `AZTECA_PAY`\n  * `SUPER_APP`\n  * `DIRECT_DEBIT`","example":"ACH"}}},{"properties":{"checkoutPaymentDetails":{"$ref":"#/components/schemas/GenericPaymentDetails"}}},{"$ref":"#/components/schemas/AdditionalPreAuthProperties"}]},"PreAuthPayPalTransaction":{"title":"PreAuthPayPalTransaction","required":["paymentMethod"],"allOf":[{"properties":{"paymentMethod":{"type":"string","description":"The name of the Payment Method. Any name will be accepted, but we strongly recommend mapping to one of the following keys if possible:\n  * `PAYPAL_ACCOUNT`","example":"PAYPAL_ACCOUNT"},"checkoutPaymentDetails":{"$ref":"#/components/schemas/GenericPaymentDetails"}}},{"$ref":"#/components/schemas/AdditionalPreAuthProperties"}]},"PreAuthGenericTransaction":{"title":"PreAuthGenericTransaction","required":["paymentMethod"],"allOf":[{"properties":{"paymentMethod":{"type":"string","description":"The name of the Payment Method. Any name will be accepted, but we strongly recommend mapping to one of the following keys if possible:\n  * `ALI_PAY`\n  * `AME`\n  * `APPLE_PAY`\n  * `AMAZON_PAYMENTS`\n  * `ANDROID_PAY`\n  * `BITCOIN`\n  * `BOLETO`\n  * `CASH`\n  * `CASHBACK`\n  * `DIGITAL_WALLET`\n  * `FREE`\n  * `GOOGLE_PAY`\n  * `LOAN`\n  * `OFFLINE`\n  * `PAYPAL_ACCOUNT`\n  * `PICPAY`\n  * `REWARD_POINTS`\n  * `STORE_CREDIT`\n  * `SAMSUNG_PAY`\n  * `VISA_CHECKOUT`\n  * `VOUCHER`\n  * `CLICK_TO_PAY`\n  * `MULTIBANCO`","example":"APPLE_PAY"}}},{"properties":{"checkoutPaymentDetails":{"$ref":"#/components/schemas/GenericPaymentDetails"}}},{"$ref":"#/components/schemas/AdditionalPreAuthProperties"}]},"PreAuthTransaction":{"anyOf":[{"$ref":"#/components/schemas/PreAuthCardTransaction"},{"$ref":"#/components/schemas/PreAuthBankTransaction"},{"$ref":"#/components/schemas/PreAuthPayPalTransaction"},{"$ref":"#/components/schemas/PreAuthGenericTransaction"}]},"PreAuthTransactions":{"description":"A list of payment authorizations that will be attempted to pay for the order.","type":"array","items":{"$ref":"#/components/schemas/PreAuthTransaction"}},"AdditionalEvalRequests":{"description":"The types of additional evaluations requested. If no additional evaluation object is provided or is empty, additional evaluation will not take place. For further information please contact your Signifyd Implementation Manager.\n  * `SCA_EVALUATION` - Use when you want SCA exemption and exclusion evaluation.\n","type":"array","items":{"type":"string","enum":["SCA_EVALUATION"]}},"DecisionMechanism":{"description":"This field specifies how the decision returned in the `decision` field will be made.\n  * `SIGNIFYD_RECOMMENDATION` - Use when you would like Signifyd's model recommendation to be the default `decision.checkpointAction`.  Your Decision Center policies will still run and potentially override the Signifyd recommendation.\n  * `POLICY_ONLY_ACCEPT` - Use when you only want your Decision Center policies to determine the `decision` with no recommendation provided by Signifyd. If no policy conditions match the evaluated order, then a `decision.checkpointAction` of `ACCEPT` will be returned. This value can only be used when the request's `coverageRequests` value is set to `NONE`.\n  * `INFO_ONLY` - Use when you want to send transactions to Signifyd but not have a decision returned. This value can only be used when the request's `coverageRequests` value is set to `NONE`.\n","type":"string","enum":["POLICY_ONLY_ACCEPT","SIGNIFYD_RECOMMENDATION","INFO_ONLY"],"default":"SIGNIFYD_RECOMMENDATION","example":"SIGNIFYD_RECOMMENDATION"},"TravelLeg":{"required":["id","departurePortCode","arrivalPortCode","departureDateTime","arrivalDateTime","isFinalDestination"],"title":"TravelLeg","type":"object","properties":{"id":{"description":"Airline: Flight number.\nAll Others: Number or identifier for the method of travel.","type":"string","example":"123"},"carrierCode":{"description":"Airline: 2 digit IATA code for airline.\nAll Others: Description of travel operator (e.g., Amtrak, National Express).","type":"string","example":"F8"},"fareBasisCode":{"description":"Code or designator that indicates the specific rules and restrictions associated with a particular fare (e.g., YWEX14NR, full-fare, reduced-fare).","type":"string","example":"YWEX14NR"},"fareClassCode":{"description":"Code or designator that indicates the class of the ticket (e.g., Y).","type":"string","example":"Y"},"fareClassName":{"description":"Description of the fare class (e.g., Economy).","type":"string","example":"ECONOMY"},"departureCity":{"description":"Departure city name of the leg.","type":"string","example":"Calgary"},"departureProvinceCode":{"description":"Departure province code of the leg.","type":"string","example":"AB"},"departureCountryCode":{"description":"Departure country code of the leg.","type":"string","example":"CAN"},"departurePortCode":{"description":"Airline: 3 digit IATA code representing the departure airport (e.g., ORD).\nAll Others: Description of the departure location (e.g., Grand Central Terminal).","type":"string","example":"YYZ"},"departureDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"description":"The date and time of the departure.","example":"2024-05-16T08:00:00-0700","type":"string"}]},"arrivalCity":{"description":"Arrival city name of the leg.","type":"string","example":"Cancún"},"arrivalProvinceCode":{"description":"Arrival province code of the leg.","type":"string","example":"QR"},"arrivalCountryCode":{"description":"Arrival country code of the leg.","type":"string","example":"MEX"},"arrivalPortCode":{"description":"Airline: 3 digit IATA code representing the arrival airport (e.g., ORD).\nAll Others: Description of the arrival location (e.g., Chicago Union Station).","type":"string","example":"CUN"},"arrivalDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"description":"The date and time of the arrival.","example":"2024-05-16T12:30:00-0700","type":"string"}]},"isFinalDestination":{"description":"Set to true if the arrivalPortcode is the end destination for the traveler. For round-trip travel, this is the final leg of the outbound journey.","type":"boolean","example":true}}},"Loyalty":{"title":"Loyalty","type":"object","properties":{"number":{"description":"Loyalty number of the passenger.","type":"string","example":"LL123457"},"sinceDate":{"type":"string","format":"date","description":"Loyalty number since date.","example":"2005-01-01"},"level":{"description":"Loyalty level.","type":"string","example":"SILVER"}}},"TravelPassenger":{"required":["id","firstName","lastName"],"title":"TravelPassenger","type":"object","properties":{"id":{"description":"Unique identifier for the passenger.","type":"string","example":"0162370892854"},"firstName":{"description":"First name of the passenger.","type":"string","example":"John"},"middleName":{"description":"Middle name of the passenger.","type":"string","example":"A"},"lastName":{"description":"Last name of the passenger.","type":"string","example":"Doe"},"suffix":{"description":"Suffix of the passenger.","type":"string","example":"Sr"},"phone":{"description":"The phone number associated with the passenger.","type":"string","example":"3125555555"},"email":{"description":"The email for the passenger.","type":"string","format":"email","example":"bob@example.com"},"loyalty":{"description":"Loyalty member info for the passenger.","allOf":[{"$ref":"#/components/schemas/Loyalty"}]},"isAwardTicket":{"description":"If the current passenger's ticket is an award ticket.","type":"boolean","example":true},"ancillaryItemsCount":{"description":"Items count for the ancillary purchase.","type":"integer","example":3}}},"TravelProduct":{"title":"TravelProduct","type":"object","properties":{"id":{"description":"`required` Airline: The PNR/Record Locator that identifies a reservation.\nAll Others: The confirmation number or identifier for the reservation.","example":"123","type":"string"},"price":{"description":"`required` Total cost including taxes and ancillary fees.","example":100,"type":"number"},"bookingType":{"description":"Type of booking.\n* `ONEWAY` - one-way ticket.\n* `ROUNDTRIP` - round-trip ticket.\n* `MULTICITY` - multicity ticket.\n* `ANCILLARY_ONLY` - only includes ancillary purchases.\n","type":"string","enum":["ONEWAY","ROUNDTRIP","MULTICITY","ANCILLARY_ONLY"],"example":"ROUNDTRIP"},"transportMethod":{"description":"`required` \nTransport method for travel.\n* `AIRLINE` - Traveling by airline.\n* `SHIP` - Traveling by ship.\n* `BUS` - Traveling by bus.\n* `TRAIN` - Traveling by train.\n","type":"string","enum":["AIRLINE","SHIP","BUS","TRAIN","TRAM"],"example":"AIRLINE"},"legs":{"description":"`required` Individual travel segments ordered by departure time, earliest first.","items":{"$ref":"#/components/schemas/TravelLeg"},"type":"array"},"passengers":{"description":"`required` A list of the passengers in this travel.","items":{"$ref":"#/components/schemas/TravelPassenger"},"type":"array"}}},"EventTicketingDetails":{"title":"EventTicketingDetails","type":"object","required":["ticketPrice"],"properties":{"ticketPrice":{"description":"Ticket price.","example":100,"type":"number"},"section":{"description":"Section identifier.","example":"Upper Deck","type":"string"},"row":{"description":"Row identifier.","example":"8","type":"string"},"seat":{"description":"Seat identifier.","example":"1","type":"string"}}},"EventTicketingProduct":{"title":"EventTicketingProduct","type":"object","properties":{"eventId":{"description":"`required` The confirmation number for the purchase.","example":"ABC123","type":"string"},"eventName":{"description":"`required` The name of the event.","example":"Taylor Swift Eras Tour","type":"string"},"eventNumberOfTickets":{"description":"`required` Total number of tickets being purchased.","example":2,"type":"integer"},"eventPrice":{"description":"`required` The total cost (including fees and taxes).","example":250,"type":"number"},"eventType":{"description":"`required` Category of the event.\n* `SPORTS` - sports event type.\n* `CONCERT` - concert event type.\n* `THEATER` - theater event type.\n* `EXCURSION` - excursion event type.\n* `TRANSIT` - transit event type.\n","type":"string","enum":["SPORTS","CONCERT","THEATER","EXCURSION","TRANSIT"],"example":"CONCERT"},"eventRisk":{"description":"Risk profile of the event.\n* `LOW` - low risk.\n* `MEDIUM` - medium risk.\n* `HIGH` - high risk.\n","type":"string","enum":["LOW","MEDIUM","HIGH"],"example":"HIGH"},"eventSaleDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"string","description":"Date the tickets went on sale.","example":"2024-07-01T00:00:00Z"}]},"eventStartDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"string","description":"`required` Date the ticket starts (valid from).","example":"2024-09-20T19:00:00Z"}]},"eventEndDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"string","description":"Date the ticket ends (valid to).","example":"2024-09-20T22:00:00Z"}]},"eventVenueId":{"description":"Code representing the event’s property address.","example":"1234","type":"string"},"eventVenueName":{"description":"`required` Name of the event facility.","example":"Madison Square Garden","type":"string"},"eventVenueAddress":{"description":"Object to hold Venue Address details.","allOf":[{"$ref":"#/components/schemas/Address"}]},"eventTicketingDetails":{"description":"`required` Array to hold individual ticket details.","type":"array","items":{"$ref":"#/components/schemas/EventTicketingDetails"}}}},"LodgingLoyalty":{"title":"LodgingLoyalty","type":"object","description":"Loyalty program information for the primary guest.","properties":{"number":{"description":"Loyalty number of the primary guest.","type":"string","example":"LL123457"},"sinceDate":{"type":"string","format":"date","description":"Date the primary guest joined the loyalty program.","example":"2005-01-01"},"level":{"description":"Loyalty level of the primary guest.","type":"string","example":"SILVER"}}},"LodgingPrimaryGuest":{"title":"LodgingPrimaryGuest","type":"object","description":"Information about the primary guest making the reservation.","required":["firstName","lastName"],"properties":{"firstName":{"description":"The first name of the primary guest making the lodging reservation.","example":"John","type":"string"},"middleName":{"description":"The middle name of the primary guest making the lodging reservation.","example":"A","type":"string"},"lastName":{"description":"The last name of the primary guest making the lodging reservation.","example":"Doe","type":"string"},"email":{"description":"The email address of the primary guest making the lodging reservation.","example":"jadoe@email.com","type":"string","format":"email"},"phone":{"description":"The phone number of the primary guest making the lodging reservation.","example":"3125555555","type":"string"},"loyalty":{"description":"Loyalty program information for the primary guest.","allOf":[{"$ref":"#/components/schemas/LodgingLoyalty"}]}}},"LodgingProduct":{"title":"LodgingProduct","type":"object","properties":{"lodgingId":{"description":"`required` The confirmation number.","example":"ABC123","type":"string"},"lodgingPrice":{"description":"`required` The total cost (including room, extras, and taxes).","example":100,"type":"number"},"lodgingPropertyId":{"description":"The lodging code that represents the property address.","example":"123456","type":"string"},"lodgingPropertyUrl":{"description":"The URL for the lodging property.","example":"https://www.marriott.com/123456","type":"string","format":"uri"},"lodgingName":{"description":"`required` The name of the lodging facility.","example":"Marriott Courtyard NYC","type":"string"},"lodgingAddress":{"description":"`required` Object to hold Lodging Address details.","allOf":[{"$ref":"#/components/schemas/Address"}]},"lodgingPrimaryGuest":{"description":"`required` Information about the primary guest making the lodging reservation.","allOf":[{"$ref":"#/components/schemas/LodgingPrimaryGuest"}]},"lodgingCheckInDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"string","description":"`required` The check-in date and time.","example":"2024-09-20T19:00:00Z"}]},"lodgingCheckOutDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"string","description":"`required` The check-out date and time.","example":"2024-09-20T19:00:00Z"}]},"lodgingCancellationDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"string","description":"`required` The date and time by which booking may be canceled for no fees/penalties.","example":"2024-09-20T19:00:00Z"}]},"lodgingRoomType":{"description":"The details of the room type.","example":"King Bed","type":"string"},"lodgingNumberOfGuests":{"description":"The total number of guests on the reservation.","example":2,"type":"integer"},"lodgingComments":{"description":"Any comments or additional description for the property.","example":"High Floor, Near Elevator","type":"string"}}},"CarRentalLoyalty":{"title":"CarRentalLoyalty","type":"object","description":"Loyalty program information for the authorized driver.","properties":{"number":{"description":"The loyalty number of the authorized driver.","type":"string","example":"892562260"},"level":{"description":"The loyalty tier or status level of the authorized driver.","type":"string","example":"Platinum"},"sinceDate":{"type":"string","format":"date","description":"The date the authorized driver joined the loyalty program.","example":"2021-01-01"}}},"CarRentalDriver":{"title":"CarRentalDriver","type":"object","description":"The details for an authorized driver of the rental car.","required":["firstName","lastName","isPrimaryDriver"],"properties":{"firstName":{"description":"The first name of the authorized driver.","type":"string","example":"John"},"middleName":{"description":"The middle name of the authorized driver.","type":"string","example":"A"},"lastName":{"description":"The last name of the authorized driver.","type":"string","example":"Doe"},"email":{"description":"The email address of the authorized driver.","type":"string","format":"email","example":"jadoe@email.com"},"phone":{"description":"The phone number of the authorized driver.","type":"string","example":"3125555555"},"isPrimaryDriver":{"description":"Indicates which authorized driver is the primary driver.","type":"boolean","example":true},"loyalty":{"description":"Loyalty program information for the authorized driver.","allOf":[{"$ref":"#/components/schemas/CarRentalLoyalty"}]}}},"CarRentalAncillary":{"title":"CarRentalAncillary","type":"object","description":"An ancillary purchased with the car rental.","properties":{"name":{"description":"The name of the ancillary.","type":"string","example":"Car Seat"},"price":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"The price of the ancillary (the total price over the duration of the rental multiplied by the quantity, not the per day price or individual price).","type":"number","example":60}]},"category":{"description":"The ancillary category.","type":"string","enum":["EQUIPMENT","SERVICES","INSURANCE"],"example":"EQUIPMENT"},"quantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"},{"description":"The quantity of the ancillary.","type":"number","example":1}]}}},"CarRentalProduct":{"title":"CarRentalProduct","type":"object","properties":{"carRentalId":{"description":"`required` The reservation number.","example":"ABC123","type":"string"},"carRentalPrice":{"description":"`required` The total cost of the car rental, excluding ancillaries, taxes, and other fees.","example":200,"type":"number"},"carRentalRateCode":{"description":"A code or alphanumeric identifier used to trigger special, negotiated discounts.","example":"B572100","type":"string"},"carRentalPaymentType":{"description":"`required` The designation for how the car rental will be paid.\n* `PAY_NOW` - the rental is paid for at the time of booking.\n* `PAY_LATER` - the rental is paid for at the time of pick-up.\n","type":"string","enum":["PAY_NOW","PAY_LATER"],"example":"PAY_NOW"},"carRentalAgencyName":{"description":"The name of the car rental agency.","example":"Avis","type":"string"},"carRentalUrl":{"description":"The URL for the car rental reservation.","example":"https://www.avis.com/123456","type":"string","format":"uri"},"carRentalAcrissCode":{"description":"A 4-character value designated by the Association of Car Rental Industry Systems Standards (ACRISS) code.","example":"IFAR","type":"string","minLength":4,"maxLength":4},"carRentalVehicleCategory":{"description":"The vehicle category (ex: Intermediate).","example":"Intermediate","type":"string"},"carRentalVehicleType":{"description":"The vehicle type (ex: SUV).","example":"SUV","type":"string"},"carRentalPurpose":{"description":"The purpose of the car rental.\n* `BUSINESS` - the rental is for business use.\n* `LEISURE` - the rental is for leisure use.\n* `BOTH` - the rental is for both business and leisure use.\n","type":"string","enum":["BUSINESS","LEISURE","BOTH"],"example":"BUSINESS"},"carRentalContractType":{"description":"The type of car rental contract.\n* `STANDARD` - a standard short-term rental.\n* `EXTENDED` - an extended-duration rental.\n* `MINI_LEASE` - a mini-lease rental.\n","type":"string","enum":["STANDARD","EXTENDED","MINI_LEASE"],"example":"STANDARD"},"carRentalAuthorizedDrivers":{"description":"`required` The details for each authorized driver of the rental car.","type":"array","items":{"$ref":"#/components/schemas/CarRentalDriver"}},"carRentalPickupDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"string","description":"`required` The car rental pick up date and time.","example":"2026-05-20T16:00:00Z"}]},"carRentalPickupLocationCode":{"description":"The pick up location code (ex: 3 digit airport code or a specific code representing the location).","example":"XYZ","type":"string"},"carRentalPickupIsAirport":{"description":"Indicates whether the pick up location is at an airport. If not provided, defaults to false.","type":"boolean","example":false},"carRentalPickupAddress":{"description":"`required` Address details for the car rental pick up location.","allOf":[{"$ref":"#/components/schemas/Address"}]},"carRentalDropoffDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"string","description":"`required` The car rental drop off date and time.","example":"2026-05-24T16:00:00Z"}]},"carRentalDropoffLocationCode":{"description":"The drop off location code (ex: 3 digit airport code or a specific code representing the location).","example":"XYZ","type":"string"},"carRentalDropoffAddress":{"description":"`required` Address details for the car rental drop off location.","allOf":[{"$ref":"#/components/schemas/Address"}]},"carRentalCancellationDateTime":{"allOf":[{"$ref":"#/components/schemas/DateTime"},{"type":"string","description":"The date and time by which the car rental may be canceled for no fees/penalties.","example":"2026-05-10T16:00:00Z"}]},"carRentalAncillaries":{"description":"Ancillary details for the car rental.","type":"array","items":{"$ref":"#/components/schemas/CarRentalAncillary"}}}},"ProductVariant":{"anyOf":[{"$ref":"#/components/schemas/Product"},{"$ref":"#/components/schemas/TravelProduct"},{"$ref":"#/components/schemas/EventTicketingProduct"},{"$ref":"#/components/schemas/LodgingProduct"},{"$ref":"#/components/schemas/CarRentalProduct"}]},"ProductVariants":{"description":"A list of products purchased on the order, can be any of `Product`, `TravelProduct`, `EventTicketingProduct`, `LodgingProduct`, or `CarRentalProduct`.\nNOTE: Only one `TravelProduct` object can be passed within the product array.\n","type":"array","items":{"$ref":"#/components/schemas/ProductVariant"}},"Purchase":{"title":"Purchase","type":"object","required":["createdAt","orderChannel","totalPrice","products","shipments"],"properties":{"createdAt":{"description":"The date and time when the order was placed. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ`. This value can be set only once per order; later Checkout or Sale events for the same order do not update it. See the dates section of the Introduction for more information about date formats.\nIf the original purchase was made more than 7 days ago (purchase.createdAt), then no decision will be returned.\n","example":"2020-12-23T13:57:40-07:00","type":"string","format":"date-time"},"orderChannel":{"title":"OrderChannel","description":"The channel or source where the order was placed.\n  * `WEB` - Orders placed online through a digital storefront.\n  * `PHONE` - Orders placed via telephone.\n  * `MOBILE_APP` - Orders placed through a native mobile application installed on the device (iOS / Android).\n  * `SOCIAL` - Orders placed directly through a social network platform (Facebook, Twitter, etc.).\n  * `MARKETPLACE` - Orders placed on a 3rd party ecommerce site where products are sold by multiple sellers (Amazon, Wish, Walmart, EBay, etc.).\n  * `IN_STORE_KIOSK` - Orders purchased at a physical store on a store-owned device and shipped to the buyer's home.\n  * `SCAN_AND_GO` - Orders purchased by using in-app scanning and skipping the checkout line.\n  * `SMART_TV` - Orders placed through an application installed on an internet-connected television (Vizio, Samsung, Roku, etc.).\n  * `MIT` - Orders that are automatically initiated by the merchant (Merchant Initiated Transaction) using stored credentials.\n  * `CHAT` - Orders placed on behalf of customers by an agent using Chat.\n  * `PAYMENT_LINK` - Orders placed where the payment is requested via a payment link.\n  * `AGENTIC` - Orders placed on behalf of customers by an AI agent.\n","type":"string","enum":["WEB","PHONE","MOBILE_APP","SOCIAL","MARKETPLACE","IN_STORE_KIOSK","SCAN_AND_GO","SMART_TV","MIT","CHAT","PAYMENT_LINK","AGENTIC"]},"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"The total amount of the order, including the shipping price, taxes, and any fees. This should be the amount you want Signifyd to provide Guarantee Fraud Protection coverage for.","example":105.99,"type":"number"}]},"currency":{"x-sig-needed":true,"description":"`needed` The currency in which the `totalPrice` and all other amounts are denominated. If omitted, the currency is assumed to be USD.","allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"","example":"GBP","type":"string"}]},"confirmationEmail":{"description":"`needed` When this purchase was completed, you likely sent a confirmation email or you will be sending a confirmation email to the buyer once you approve the order. This is the email address to which that confirmation email will be sent. You must provide a valid email syntax.","type":"string","x-sig-needed":true,"format":"email","example":"bob@example.com"},"products":{"$ref":"#/components/schemas/ProductVariants"},"shipments":{"description":"Details about the delivery destinations and the products for each one.","type":"array","items":{"$ref":"#/components/schemas/Shipment"}},"confirmationPhone":{"description":"`needed` The phone number at which the buyer would be contacted if there was something wrong with this order or the phone number that was supplied with the shipping information.","type":"string","x-sig-needed":true,"example":"+442071838750"},"totalShippingCost":{"x-sig-needed":true,"description":"`needed` The total amount the customer is paying for shipping the products.","allOf":[{"$ref":"#/components/schemas/Price"},{"description":"`needed` The total amount the customer is paying for shipping the products."},{"x-sig-description":"`needed` The total amount the customer is paying for shipping the products.","example":5.99,"type":"number"}]},"discountCodes":{"description":"`needed` A list of discount, coupon, or promotional codes applied during checkout. This data is used to analyze patterns of promotional usage and detect potential misuse or abuse.\n\nEach code should include the associated discount amount or percentage. If both amount and percentage are provided for a single code, the percentage will be ignored.","items":{"$ref":"#/components/schemas/DiscountCodes"},"type":"array"},"receivedBy":{"description":"If the order was placed on behalf of a customer service or sales agent, their name.","type":"string","nullable":true},"orderSource":{"description":"The source or channel through which the order was placed. \n- `AFFILIATE`: Order originated through an affiliate marketing channel, including orders placed via affiliate links, partner referrals, or commission-based marketing programs.\n- `DIRECT`: Order was placed directly through the merchant's primary channels, such as the merchant's website, mobile app, or other direct customer interactions without third-party referrals.\n- `ORGANIC`: Order originated from organic traffic sources, including customers who found the merchant through unpaid search results, bookmarks, or direct navigation without any promotional or referral influence.\n- `REFERRAL`: Order came through a referral source, including customers referred by other websites, social media platforms, or external links that are not part of formal affiliate programs.\n","enum":["AFFILIATE","DIRECT","ORGANIC","REFERRAL"],"title":"OrderSource","type":"string","example":"AFFILIATE"}}},"Count":{"type":"integer","format":"int64","minimum":1,"example":1},"PaymentDetails":{"allOf":[{"$ref":"#/components/schemas/BasePaymentDetails"},{"properties":{"cardBrand":{"description":"The name of the card brand, e.g. Visa or Mastercard.  Note, it is preferred that you provide a cardBin rather than providing this field directly.\n\nIf using a co-branded card, if unbranded pass the merchant name else use the card brand that was selected at checkout eg., VISA, AMEX.\n\nAny value will be accepted, but we strongly recommend mapping to one of the following keys if possible.  Please reach out to our implementations team if you believe there is an important key missing.\n  * `AMEX`\n  * `DANKORT`\n  * `DINERS_CLUB`\n  * `DISCOVER`\n  * `ELO`\n  * `FORBRUGSFORENINGEN`\n  * `HIPERCARD`\n  * `JCB`\n  * `MAESTRO`\n  * `MASTERCARD`\n  * `UNIONPAY`\n  * `VISA`\n","type":"string"},"cardFunding":{"description":"The funding methodology of the card.  Note, it is preferred that you provide a cardBin rather than providing this field directly.  If you are providing cardBin there is no need to populate this field.  Any value will be accepted, but we strongly recommend mapping to one of the following keys if possible.  Please reach out to our Implementations team if you believe there is an important key missing.\n  * `CREDIT` - Use for credit card payments\n  * `DEBIT` - Use for debit card payments\n  * `PREPAID` - Use for pre-paid card and/or gift card payments\n  * `SNAP` - Use for payments funded by Supplemental Nutrition Assistance Program cards\n","type":"string"},"gateway":{"description":"The name of the payment gateway or financial institution that processed the transaction.","type":"string","example":"braintree"},"verifications":{"$ref":"#/components/schemas/Verifications"}}}]},"SavedPaymentMethod":{"title":"SavedPaymentMethod","type":"object","required":["paymentMethod"],"properties":{"date":{"description":"The date this payment information was last updated or verified. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ`. See the dates section of the Introduction for more information about date formats.\n","example":"2020-12-23T13:57:40-07:00","type":"string","format":"date-time"},"paymentMethod":{"description":"The name of the Payment Method saved to the Account. Any name will be accepted, but we strongly recommend mapping to one of the following keys if possible:\n  * `CREDIT_CARD`\n  * `GIFT_CARD`\n  * `DEBIT_CARD`\n  * `PREPAID_CARD`\n  * `SNAP_CARD`\n  * `BANK_ACCOUNT`\n","type":"string","example":"CREDIT_CARD"},"paymentDetails":{"$ref":"#/components/schemas/PaymentDetails"}}},"SavedAddress":{"allOf":[{"$ref":"#/components/schemas/Address"},{"type":"object","properties":{"addressType":{"type":"string","enum":["shipping","billing"]}}}]},"UserAccount":{"type":"object","title":"UserAccount","description":"`needed` An object containing key details used to evaluate the legitimacy of a user account and its associated activity during a transaction. This includes user account data such as email address, account creation date, and other relevant attributes. These details are crucial for identifying patterns that may indicate suspicious or potentially fraudulent behavior.","required":["username"],"properties":{"username":{"description":"The username associated with the account. Please supply this even if it is the same as the `email`.","type":"string","example":"bobiverse"},"createdDate":{"type":"string","format":"date-time","description":"`needed` The date when the account was created. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-23T13:57:40-07:00"},"accountId":{"description":"`needed` Your globally unique identifier for registered user accounts. Use this as the persistent user identifier, consistent with Account Integrity APIs.","type":"string","x-sig-needed":true,"example":"q49sgfkj49"},"accountNumber":{"description":"`needed` Your unique identifier for the user. May apply to all checkouts, including guest sessions.","type":"string","x-sig-needed":true,"example":"q49sgfkj49"},"aggregateOrderCount":{"allOf":[{"$ref":"#/components/schemas/Count"},{"description":"The total count of orders placed by this account since it was created, including the current order.","example":1,"type":"integer","format":"int64"}]},"aggregateOrderDollars":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"The total amount spent by this account since it was created, including the current order. This value should be passed in the local currency set for the merchant's account.","example":105.99,"type":"number"}]},"email":{"description":"`needed` The primary email address associated with the account.","type":"string","x-sig-needed":true,"format":"email","example":"bob@example.com"},"phone":{"description":"`needed` The primary phone number associated with the account.","type":"string","x-sig-needed":true,"example":"+442071838750"},"lastOrderId":{"description":"The unique identifier for the last successfully placed order by this account, prior to the current order.","type":"string","nullable":true},"lastUpdateDate":{"type":"string","format":"date-time","description":"`needed` The last time a change was made to this account other than an order being placed. Examples include changing email addresses or adding a new credit card. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-23T13:57:40-07:00"},"emailLastUpdateDate":{"type":"string","format":"date-time","description":"`needed` The last time a change was made to the email address of this account. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-23T13:57:40-07:00"},"phoneLastUpdateDate":{"type":"string","format":"date-time","description":"The last time a change was made to the phone number of this account. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-23T13:57:40-07:00"},"passwordLastUpdateDate":{"type":"string","format":"date-time","description":"`needed` The last time a change was made to the password of this account. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-23T13:57:40-07:00"},"savedPayments":{"items":{"$ref":"#/components/schemas/SavedPaymentMethod"},"type":"array","description":"An array of payment methods added to the account."},"savedAddresses":{"items":{"$ref":"#/components/schemas/SavedAddress"},"type":"array","description":"An array of addresses added to the account."},"associateId":{"description":"Unique identifier of the associate linked to this order, such as employee ID.","type":"string","example":"12568chjaipl"}}},"CoverageRequests":{"description":"`needed` The types of coverages requested. If no coverage object is provided or is empty, coverage will be set to the team's default policy.\nFor further information please contact your Signifyd Implementation manager.\n* `FRAUD` - use when you need a financial guarantee for Payment Fraud.\n* `INR` - use when you need a financial guarantee for Item Not Received.\n* `SNAD` - use when you need a financial guarantee for fraud alleging items are Significantly Not As Described.\n* `ALL` - use when you need a financial guarantee on all chargebacks.\n* `NONE` - use when you do not need a financial guarantee. Suggested actions in `decision.checkpointAction` are recommendations.\n","type":"array","x-sig-needed":true,"items":{"type":"string","enum":["FRAUD","INR","SNAD","ALL","NONE"]}},"BaseOrder":{"type":"object","required":["orderId","purchase"],"properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"purchase":{"description":"Details about the products that were purchased and how the purchase was made.","allOf":[{"$ref":"#/components/schemas/Purchase"}]},"userAccount":{"$ref":"#/components/schemas/UserAccount"},"memberships":{"description":"The membership object should be used to indicate the use of a buyer’s rewards, discounts, or admission programs during the purchase. Common uses include but are not limited to, memberships like Costco, Amazon Prime, Walmart+, and Airline Frequent Flyer programs. This object is conceptually distinct from userAccount whose attributes relate to the online account that was used by the buyer to complete the purchase; it's what the buyer \"logs in to\". You would never login to a \"membership\".","items":{"$ref":"#/components/schemas/Membership"},"type":"array"},"coverageRequests":{"$ref":"#/components/schemas/CoverageRequests"},"merchantCategoryCode":{"$ref":"#/components/schemas/MerchantCategoryCode"}}},"Seller":{"title":"Seller","type":"object","properties":{"accountNumber":{"description":"`needed` Your unique identifier for this Seller's account.","type":"string","example":"23432-dse"},"aggregateOrderCount":{"allOf":[{"$ref":"#/components/schemas/Count"},{"description":"`needed` The total count of orders sold by this seller since it was created, including the current order.","example":4,"type":"integer","format":"int64"}]},"aggregateOrderDollars":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"`needed` The total amount, in US dollars, sold by this seller since it was created, including the current order.","example":415.84,"type":"number"}]},"contactAddress":{"description":"The address registered on the Seller account at which they say they should be contacted.","allOf":[{"$ref":"#/components/schemas/Address"}]},"createdDate":{"type":"string","format":"date-time","description":"`needed` The date when the seller account was created on your site. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-23T13:57:40-07:00"},"domain":{"description":"`needed` The domain of the seller.","type":"string","example":"mystore.com"},"email":{"description":"`needed` The primary email address currently associated with the seller.","type":"string","format":"email","example":"myawesomedrones@gmail.com"},"lastUpdateDate":{"type":"string","format":"date-time","description":"`needed` The last time a change was made to this seller (e.g. changed email). Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-23T13:57:40-07:00"},"name":{"description":"`needed` The business name of the seller.","type":"string","example":"Awesome Drones Inc."},"onboardingEmail":{"description":"`needed` The email address associated with this seller account when it was created.","type":"string","format":"email","example":"myawesomedrones@gmail.com"},"onboardingIpAddress":{"description":"The IP address of the device used when this seller account was created.","type":"string","example":"51.202.206.33"},"parentEntity":{"description":"The unique ID of the parent entity associated with the seller.","type":"string","example":"Kroger"},"phone":{"description":"The phone number associated with the seller.","type":"string","example":"+442071838750"},"sellerId":{"description":"The unique ID of the seller generated by the parent entity.","type":"string","example":"3732692146"},"tags":{"description":"A list of attributes or short descriptors associated with the seller account.","type":"array","items":{"type":"string","example":"TOP_SELLER"}},"username":{"description":"The unique username associated with the seller. This will likely be whatever they use to login to your site. Please supply this even if it is the same as the email address.","type":"string","example":"isellawesomedrones"}}},"LowerPriorityProperties":{"type":"object","properties":{"sellers":{"description":"Use only if you operate a marketplace (e.g. eBay) and allow other merchants to list and sell products on the online store. A seller is an online account for the merchant or business that listed and sold the product(s) on the order.","items":{"$ref":"#/components/schemas/Seller"},"type":"array"},"tags":{"description":"A list of attributes or short descriptors associated with the order.","type":"array","items":{"type":"string","example":"JULY_FACEBOOK_CAMPAIGN"}}}},"customerOrderRecommendation":{"type":"string","description":"If you have a risk system independent of Signifyd, use this field to pass us the decision from that system. For declines, use either DECLINE_POLICY or DECLINE_FRAUD whenever possible. DECLINE should only be used if the underlying reason is unknown","enum":["DECLINE_POLICY","DECLINE_FRAUD","APPROVE","REVIEW","DECLINE","MR_APPROVE","MR_DECLINE_FRAUD","MR_TIMEOUT"]},"AdditionalProperties":{"type":"object","properties":{"customerOrderRecommendation":{"$ref":"#/components/schemas/customerOrderRecommendation"}}},"Checkout":{"title":"Checkout","required":["checkoutId"],"allOf":[{"properties":{"checkoutId":{"$ref":"#/components/schemas/CheckoutId"},"device":{"$ref":"#/components/schemas/Device"},"merchantPlatform":{"$ref":"#/components/schemas/MerchantPlatform"},"signifydClient":{"$ref":"#/components/schemas/SignifydClient"},"transactions":{"$ref":"#/components/schemas/PreAuthTransactions"},"additionalEvalRequests":{"$ref":"#/components/schemas/AdditionalEvalRequests"},"decisionMechanism":{"$ref":"#/components/schemas/DecisionMechanism"}}},{"$ref":"#/components/schemas/BaseOrder"},{"$ref":"#/components/schemas/LowerPriorityProperties"},{"$ref":"#/components/schemas/AdditionalProperties"}]},"DecisionResponse":{"allOf":[{"$ref":"#/components/schemas/CheckpointDecisionResponse"},{"properties":{"score":{"description":"A value from 0-1000 indicating the likelihood that the order is fraud. 0 indicates the highest risk, 1000 indicates the lowest risk.","type":"number","nullable":true,"format":"double"}}}]},"StepUpMethodType":{"title":"Step-Up Method Type","description":"The step-up verification method.\n* `SMS_VERIFICATION` - Verification via SMS code sent to a trusted phone number.\n* `THREE_DS` - Verification via 3-D Secure.\n* `PHONE_OTP` - Verification via a one-time password sent to a trusted phone number.\n* `EMAIL_OTP` - Verification via a one-time password sent to a trusted email address.\n","type":"string","enum":["SMS_VERIFICATION","THREE_DS","PHONE_OTP","EMAIL_OTP"],"example":"SMS_VERIFICATION"},"AvailableStepUp":{"title":"Available Step-Up","type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/StepUpMethodType"},"accountPhone":{"description":"The phone number to send the `PHONE_OTP` code to. This is the `userAccount.phone` provided on the Checkout, returned unchanged. Only present if `type` is `PHONE_OTP` and `userAccount.phone` was provided.","type":"string","nullable":true,"example":"+14155551212"},"accountEmail":{"description":"The email address to send the `EMAIL_OTP` code to. This is the `userAccount.email` provided on the Checkout, returned unchanged. Only present if `type` is `EMAIL_OTP` and `userAccount.email` was provided.","type":"string","nullable":true,"example":"buyer@example.com"}}},"CheckoutDecisionResponse":{"allOf":[{"$ref":"#/components/schemas/DecisionResponse"},{"properties":{"availableStepUps":{"description":"Step-up verification methods available for this order when `checkpointAction` is `STEP_UP`.\nOnly returned on the pre-authorization Checkout response. Omitted when empty or when the\ndecision is not a step-up.\n`PHONE_OTP` includes `accountPhone` and `EMAIL_OTP` includes `accountEmail` when the\nmatching `userAccount` field was provided. `THREE_DS` includes only `type`.\n","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/AvailableStepUp"},"example":[{"type":"PHONE_OTP","accountPhone":"+14155551212"}]}}}]},"Outcome":{"type":"string","description":"Outcomes for Signifyd's SCA Evaluation product: * `REQUEST_EXEMPTION` - Signifyd evaluated that an SCA Exemption should be requested. * `REQUEST_EXCLUSION` - Signifyd evaluated that an SCA Exclusion should be requested. * `DELEGATE_TO_PSP` - Signifyd could not find an SCA exclusion or exemption and allow the PSP to decide how to proceed. * `NOT_EVALUATED` - SCA Evaluation did not take place even though it was requested. SCA Evaluation only takes place when `decision.checkpointAction` = `ACCEPT` or `HOLD`. If further information is required, please contact your Signifyd Implementation manager.\n","enum":["REQUEST_EXEMPTION","REQUEST_EXCLUSION","DELEGATE_TO_PSP","NOT_EVALUATED"]},"ExclusionDetails":{"type":"object","title":"exclusionDetails","required":["exclusion"],"description":"Details on Signifyd's evaluation that the order is out of SCA regulatory scope. Only present if outcome = `REQUEST_EXCLUSION`.\n","properties":{"exclusion":{"type":"string","description":"SCA Exclusion types: * `ONE_LEG_OUT` - Order is out of SCA scope as either or both the merchant and the cardholder's bank are not located in the EEA. * `MIT` - Order is out of SCA scope as the order is a subsequent payment of a series of recurring payments to the same business. * `MOTO` - Order is out of SCA scope as payments with card details collected over the phone do not require authentication. * `ANONYMOUS_PREPAID` - Order is out of SCA scope as it has been made using an anonymous prepaid card, eg. gift card.\n","enum":["ONE_LEG_OUT","MIT","MOTO","ANONYMOUS_PREPAID"]}}},"Exemption":{"type":"string","enum":["TRA","LOW_VALUE"],"example":"TRA"},"ExemptionDetails":{"type":"object","title":"exemptionDetails","required":["exemption","placement"],"description":"Details on Signifyd's evaluation that the transaction should be sent to the merchant's bank for SCA exemption. Only present if outcome = `REQUEST_EXEMPTION`.\n","properties":{"exemption":{"description":"SCA Exemption types: * `LOW_VALUE` - Signifyd evaluated that the transaction should be sent to the acquirer for low value exemption. * `TRA` - Signifyd evaluated that the transaction should be sent to the acquirer for low risk exemption.\n","allOf":[{"$ref":"#/components/schemas/Exemption"}]},"placement":{"type":"string","description":"Whether the transaction should be authenticated or sent straight to authorization: * `AUTHENTICATION` - Signifyd evaluated that the transaction should be sent via 3DS Authentication. * `AUTHORIZATION` - Signifyd evaluated that the transaction should be sent straight for authorization.\n","enum":["AUTHENTICATION","AUTHORIZATION"]}}},"ScaEvaluation":{"title":"SCA Evaluation","type":"object","description":"Signifyd's evaluation of whether the Order is in scope for Strong Customer Authentication requirements. You can use this recommendation to request exemptions from your PSP and minimize SCA based friction. Contact your CS team member to get more details on your PSP's exemption management.\n","required":["outcome"],"example":{"outcome":"REQUEST_EXEMPTION","exemptionDetails":{"exemption":"TRA","placement":"AUTHORIZATION"}},"properties":{"outcome":{"$ref":"#/components/schemas/Outcome"},"exclusionDetails":{"allOf":[{"$ref":"#/components/schemas/ExclusionDetails"}]},"exemptionDetails":{"allOf":[{"$ref":"#/components/schemas/ExemptionDetails"}]}}},"CheckoutResponse":{"title":"CheckoutResponse","type":"object","required":["signifydId","checkoutId","orderId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"checkoutId":{"allOf":[{"description":"Unique identifier for a checkout.  If you are executing a PreAuthorization flow, then you must retain this value for your subsequent `Record Transaction` call.","type":"string"},{"$ref":"#/components/schemas/CheckoutId"}]},"orderId":{"allOf":[{"description":"Unique identifier for the order.  You should retain the value so you can retrieve summary information about the order later.","type":"string"},{"$ref":"#/components/schemas/OrderId"}]},"decision":{"$ref":"#/components/schemas/CheckoutDecisionResponse"},"coverage":{"$ref":"#/components/schemas/Coverage"},"scaEvaluation":{"allOf":[{"$ref":"#/components/schemas/ScaEvaluation"}]}}},"RepricePurchase":{"title":"Purchase","type":"object","required":["totalPrice","products"],"properties":{"totalPrice":{"allOf":[{"$ref":"#/components/schemas/Price"},{"description":"The total amount of the order, including the shipping price, taxes, and any fees. This should be the amount you want Signifyd to provide Guarantee Fraud Protection coverage for.","example":105.99}]},"currency":{"x-sig-needed":true,"description":"`needed` The currency in which the `totalPrice` and all other amounts are denominated. If omitted, the currency is assumed to be USD.","allOf":[{"$ref":"#/components/schemas/Currency"},{"description":"","example":"GBP"}]},"products":{"description":"A list of products purchased on the order and going to the given `destination`.","items":{"$ref":"#/components/schemas/Product"},"type":"array"},"totalShippingCost":{"x-sig-needed":true,"description":"`needed` The total amount the customer is paying for shipping the products.","allOf":[{"$ref":"#/components/schemas/Price"},{"description":"`needed` The total amount the customer is paying for shipping the products."},{"x-sig-description":"`needed` The total amount the customer is paying for shipping the products.","example":5.99}]},"discountCodes":{"description":"A list of discount codes, coupons, or promotional codes used during checkout to receive a discount on the order. An amount or percentage must be provided along with the discount code. If an amount and percentage are provided for a given discount code, percentage will be ignored.","items":{"$ref":"#/components/schemas/DiscountCodes"},"type":"array"}}},"Reprice":{"title":"Reprice","required":["orderId","purchase"],"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"purchase":{"$ref":"#/components/schemas/RepricePurchase"}}},"RepriceResponse":{"title":"Reprice Response","type":"object","required":["signifydId","orderId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"orderId":{"allOf":[{"description":"Unique identifier for the order.","type":"string"},{"$ref":"#/components/schemas/OrderId"}]},"coverage":{"description":"The updated coverage information after the reprice has been performed. Note, this endpoint is eventually consistent.  If you attempt to retrieve the Order immediately following a call to this endpoint, it may show a different coverage.  It will evntually be updated.","allOf":[{"$ref":"#/components/schemas/Coverage"}]}}},"PostAuthRequiredProperties":{"allOf":[{"type":"object","required":["transactionId","gatewayStatusCode"],"properties":{"transactionId":{"description":"The unique identifier provided by the payment provider for the payment. If you have provided us with credentials for your payment gateway we can obtain additional details about the order, like AVS and CVV status, from your payment provider.","type":"string","example":"4927wwllds49"},"gatewayStatusCode":{"$ref":"#/components/schemas/GatewayStatusCode"}}}]},"AdditionalPostAuthProperties":{"properties":{"gatewayErrorCode":{"type":"string","nullable":true,"enum":["CARD_DECLINED","CALL_ISSUER","EXPIRED_CARD","FRAUD_DECLINE","INCORRECT_NUMBER","INVALID_NUMBER","INVALID_EXPIRY_DATE","INVALID_CVC","INCORRECT_CVC","INCORRECT_ZIP","INCORRECT_ADDRESS","INSUFFICIENT_FUNDS","PROCESSING_ERROR","PICK_UP_CARD","RESTRICTED_CARD","STOLEN_CARD","TEST_CARD_DECLINE"]},"gatewayStatusMessage":{"description":"Additional information provided by the payment provider describing why the transaction succeeded or failed.","type":"string","nullable":true},"createdAt":{"description":"The date and time when the transaction was processed by the payment provider. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","example":"2020-12-23T13:57:40-0700","type":"string","format":"date-time"},"parentTransactionId":{"description":"If there was a previous transaction for the payment like a partial AUTHORIZATION or SALE, the parent id should include the originating transaction id.","type":"string","nullable":true},"scaExemptionRequested":{"allOf":[{"$ref":"#/components/schemas/Exemption"},{"description":"The SCA exemption that was requested by the merchant. * `TRA` - Transaction evaluated to be a low risk * `LOW_VALUE` - Transaction evaluated to be low value\n","type":"string","example":"TRA"}]}}},"IssuerExemption":{"type":"string","enum":["TRA","LOW_VALUE","SECURE_CORPORATE","TRUSTED_BENEFICIARY"]},"ThreeDsResult":{"title":"ThreeDsResult","description":"These are details about the result of the 3D Secure authentication","type":"object","required":["version"],"properties":{"eci":{"type":"string","description":"`needed` The Electronic Commerce Indicator returned from the schemes for the 3DS payment session.\n","example":"02"},"cavv":{"description":"`needed`The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session. (base64 encoded, 20 bytes in a decoded form)\n","type":"string","example":"MAAAAAAAAAAAAAAAAAAAAAAAAAA="},"version":{"type":"string","description":"The 3D Secure version.","example":"2.2"},"transStatus":{"description":"`needed` This is the transStatus value as defined in the 3D Secure 2 specification. * `AUTHENTICATION_SUCCESS` - successful authentication (Equivalent field on the 3DS spec is the transStatus field 'Y') * `AUTHENTICATION_ATTEMPTED` - authentication not verified, but an attempt at authentication was made (Equivalent field on the 3DS spec is the transStatus field 'A') * `AUTHENTICATION_FAILED` - authentication could not be verified (Equivalent field on the 3DS spec is the transStatus field 'N') * `AUTHENTICATION_UNAVAILABLE` - authentication not possible due to technical or other reason (Equivalent field on the 3DS spec is the transStatus field 'U') * `AUTHENTICATION_REJECTED` - issuer has rejected the authentication attempt (Equivalent field on the 3DS spec is the transStatus field 'R') * `INFORMATION_ONLY` - authentication not requested by the 3DS Server for data sent for informational purposes only (Equivalent field on the 3DS spec is the transStatus field 'I')\n","type":"string","enum":["AUTHENTICATION_SUCCESS","AUTHENTICATION_ATTEMPTED","AUTHENTICATION_FAILED","AUTHENTICATION_UNAVAILABLE","AUTHENTICATION_REJECTED","INFORMATION_ONLY"],"example":"AUTHENTICATION_SUCCESS"},"transStatusReason":{"description":"Additional information on why the status field has the specified value. This the transStatusReason value as defined in the 3D Secure 2 specification.\n","type":"string","nullable":true},"acsOperatorId":{"description":"Directory server assigned access control server identifier.\n","type":"string","nullable":true,"example":"AcsOpId 4138359541"},"dsTransId":{"description":"Universally unique identifier assigned by the directory server to identifier a single transaction.\n","type":"string","nullable":true,"example":"1cf815e5-cc85-436f-8e13-9f5e5aea731d"},"threeDsServerTransId":{"description":"Universally Unique identifier assigned by the 3DS Server to identify a single transaction.\n","type":"string","nullable":true,"example":"b85d3eb5-d2d2-45af-bc1b-6188021ae605"},"cavvAlgorithm":{"description":"The CAVV algorithm used for authentication.\n","type":"string","nullable":true,"example":"0"},"exemptionIndicator":{"allOf":[{"$ref":"#/components/schemas/IssuerExemption"},{"description":"The exemption applied by the issuing bank while processing the payment via Authentication. * `TRA` - Transaction evaluated to be a low risk * `LOW_VALUE` - Transaction evaluated to be low value * `SECURE_CORPORATE` - Transaction involving a corporate card * `TRUSTED_BENEFICIARY` - Transaction involving a trusted beneficiary\n","example":"TRA","type":"string"}]},"timestamp":{"type":"string","format":"date-time","description":"A timestamp of the 3DS authentication. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","nullable":true,"example":"2020-12-23T13:57:40-0700"}}},"PostAuthCardTransaction":{"title":"PostAuthCardTransaction","allOf":[{"$ref":"#/components/schemas/PostAuthRequiredProperties"},{"$ref":"#/components/schemas/PreAuthCardTransaction"},{"$ref":"#/components/schemas/AdditionalPostAuthProperties"},{"properties":{"verifications":{"$ref":"#/components/schemas/Verifications"},"threeDsResult":{"$ref":"#/components/schemas/ThreeDsResult"}}}]},"PostAuthBankTransaction":{"title":"PostAuthBankTransaction","allOf":[{"$ref":"#/components/schemas/PostAuthRequiredProperties"},{"$ref":"#/components/schemas/PreAuthBankTransaction"},{"$ref":"#/components/schemas/AdditionalPostAuthProperties"}]},"PostAuthPayPalTransaction":{"title":"PostAuthPayPalTransaction","allOf":[{"$ref":"#/components/schemas/PostAuthRequiredProperties"},{"$ref":"#/components/schemas/PreAuthPayPalTransaction"},{"$ref":"#/components/schemas/AdditionalPostAuthProperties"},{"properties":{"paypalPendingReasonCode":{"title":"paypalPendingReasons","type":"string","enum":["CHARGEBACK","GUARANTEE","BUYER_COMPLAINT","REFUND","UNCONFIRMED_SHIPPING_ADDRESS","ECHECK","INTERNATIONAL_WITHDRAWAL","RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION","PAYMENT_REVIEW","REGULATORY_REVIEW","UNILATERAL","VERIFICATION_REQUIRED","TRANSACTION_APPROVED_AWAITING_FUNDING"]},"paypalProtectionEligibility":{"enum":["ELIGIBLE","PARTIALLY_ELIGIBLE","INELIGIBLE"],"title":"ProtectionEligibility","type":"string","description":"Indicates whether the payment is eligible for PayPal Seller Protection. For more information, see [PayPal Seller Protection](https://www.paypal.com/us/cshelp/article/what-is-paypal-seller-protection-help156).\n  * `ELIGIBLE` - The transaction is eligible for both Unauthorized transaction and Item not received coverage from PayPal.\n  * `PARTIALLY_ELIGIBLE` - The transaction is only eligible for Item not received coverage from PayPal.\n  * `INELIGIBLE` - The transaction is not eligible for either coverage from PayPal."},"paypalProtectionEligibilityType":{"enum":["ITEM_NOT_RECEIVED_ELIGIBLE","UNAUTHORIZED_PAYMENT_ELIGIBLE","ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE"],"title":"ProtectionEligibilityType","type":"string","deprecated":true,"description":"This field is deprecated.  Use `paypalProtectionEligibility` instead."},"threeDsResult":{"$ref":"#/components/schemas/ThreeDsResult"}}}]},"PostAuthGenericTransaction":{"title":"PostAuthGenericTransaction","allOf":[{"$ref":"#/components/schemas/PostAuthRequiredProperties"},{"$ref":"#/components/schemas/PreAuthGenericTransaction"},{"$ref":"#/components/schemas/AdditionalPostAuthProperties"},{"properties":{"threeDsResult":{"$ref":"#/components/schemas/ThreeDsResult"}}}]},"PostAuthTransaction":{"anyOf":[{"$ref":"#/components/schemas/PostAuthCardTransaction"},{"$ref":"#/components/schemas/PostAuthBankTransaction"},{"$ref":"#/components/schemas/PostAuthPayPalTransaction"},{"$ref":"#/components/schemas/PostAuthGenericTransaction"}]},"PostAuthTransactions":{"description":"A list of payment authorizations that were attempted to pay for the order.","type":"array","items":{"$ref":"#/components/schemas/PostAuthTransaction"}},"StepUpResult":{"title":"StepUpResult","description":"Result of an issued step-up challenge, sent after the challenge completes. If this field is omitted on a later Transaction after Signifyd already offered a step-up, the outcome is treated as `OVERRIDDEN` with no result type.\n","type":"object","required":["type","outcome"],"properties":{"type":{"allOf":[{"$ref":"#/components/schemas/StepUpMethodType"},{"description":"Step-up method; must match a method offered in the Checkout decision `availableStepUps`. Required on the request. Not used when `outcome` is `OVERRIDDEN`.\n"}]},"outcome":{"description":"Challenge outcome.\n  * `SUCCESS` - Customer successfully completed the verification.\n  * `FAILURE` - Customer failed or abandoned the verification.\n  * `OVERRIDDEN` - Merchant skipped the offered step-up and continued without a challenge result.\n    No result type is associated with this outcome. Omitting `stepUpResult` after a step-up was\n    offered is treated the same as sending `OVERRIDDEN`.","type":"string","enum":["SUCCESS","FAILURE","OVERRIDDEN"],"example":"SUCCESS"}}},"TransactionsRequest":{"title":"Transaction","type":"object","description":"An event that records a Transaction.","required":["checkoutId","orderId","transactions"],"properties":{"checkoutId":{"allOf":[{"description":"Unique identifier for a checkout.  This id is used to link these transactions with the original `Record Checkout` event.  It must be supplied to ensure proper linking.","type":"string","example":"29bd5784-d3e0-4baa-bd2f-dbb82d90406d"},{"$ref":"#/components/schemas/CheckoutId"}]},"orderId":{"allOf":[{"description":"Unique identifier for an Order. This is required to link this transaction to the original Order created by the Checkout event.","type":"string","example":"XGR-1840823423"},{"$ref":"#/components/schemas/OrderId"}]},"transactions":{"$ref":"#/components/schemas/PostAuthTransactions"},"stepUpResult":{"$ref":"#/components/schemas/StepUpResult"}}},"TransactionsResponse":{"title":"Transaction Response","type":"object","required":["signifydId","checkoutId","orderId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"checkoutId":{"$ref":"#/components/schemas/CheckoutId"},"orderId":{"$ref":"#/components/schemas/OrderId"},"decision":{"$ref":"#/components/schemas/DecisionResponse"},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"DecisionDelivery":{"type":"string","description":"Specify `SYNC` if you require the Response to contain a `decision` field.  If you have registered a webhook endpoint associated with this checkpoint, then a response will be sent to the webhook endpoint even if `SYNC` is specified.\nIf `ASYNC_ONLY` is specified, then the `decision` field in the response will be `null`, and you will need to register a webhook endpoint to receive Signifyd's final `decision` via webhook.","enum":["SYNC","ASYNC_ONLY"],"default":"ASYNC_ONLY","example":"ASYNC_ONLY"},"Sale":{"title":"Sale","allOf":[{"$ref":"#/components/schemas/BaseOrder"},{"properties":{"decisionDelivery":{"$ref":"#/components/schemas/DecisionDelivery"},"device":{"$ref":"#/components/schemas/Device"},"merchantPlatform":{"$ref":"#/components/schemas/MerchantPlatform"},"signifydClient":{"$ref":"#/components/schemas/SignifydClient"},"transactions":{"$ref":"#/components/schemas/PostAuthTransactions"},"decisionMechanism":{"$ref":"#/components/schemas/DecisionMechanism"}}},{"$ref":"#/components/schemas/LowerPriorityProperties"},{"$ref":"#/components/schemas/AdditionalProperties"}]},"SaleResponse":{"title":"Sale Response","type":"object","required":["signifydId","orderId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"orderId":{"allOf":[{"description":"Unique identifier for the order.  You should retain the value so you can retrieve summary information about the order later.","type":"string"},{"$ref":"#/components/schemas/OrderId"}]},"decision":{"description":"Signifyd's Decision for this event. Populated only when `decisionDelivery` is set to `\"SYNC\"`. Otherwise will be `null` and you will require a webhook integration to receive Signifyd's final decision.","allOf":[{"$ref":"#/components/schemas/DecisionResponse"}]},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"Reroute":{"title":"Reroute","type":"object","description":"An event that records a change in the Delivery Address on the Order.","required":["orderId","shipments"],"properties":{"orderId":{"allOf":[{"$ref":"#/components/schemas/OrderId"},{"description":"The unique identifier for the order. This must be the same order ID originally provided in the Checkout/Sale event."}]},"device":{"$ref":"#/components/schemas/Device"},"shipments":{"description":"Details about the delivery destinations and the products for each one.","type":"array","items":{"$ref":"#/components/schemas/Shipment"}}}},"RerouteResponse":{"title":"Reroute Response","type":"object","required":["signifydId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"decision":{"$ref":"#/components/schemas/DecisionResponse"},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"GetDecisionResponse":{"title":"Decision Response","type":"object","required":["signifydId","orderId"],"properties":{"signifydId":{"$ref":"#/components/schemas/SignifydId"},"orderId":{"allOf":[{"description":"Unique identifier for the order.  You should retain the value so you can retrieve summary information about the order later.","type":"string"},{"$ref":"#/components/schemas/OrderId"}]},"decision":{"description":"Signifyd's Decision for this event.","allOf":[{"$ref":"#/components/schemas/DecisionResponse"}]},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"Decisions":{"title":"Decisions","type":"array","items":{"$ref":"#/components/schemas/GetDecisionResponse"}},"FulfillmentStatus":{"enum":["PARTIAL","COMPLETE","REPLACEMENT","CANCELED"],"description":"Statuses to indicate fulfillment state.\n  * PARTIAL - Some of the items in the order have not been shipped.\n  * COMPLETE - All of the items in the order have been shipped.\n  * REPLACEMENT - A replacement for one of the items in the order has been shipped.\n  * CANCELED - For some or all of the items in the order, shipment was canceled.","title":"FulfillmentStatus","type":"string"},"ShipmentId":{"type":"string","description":"Unique identifier for the Fulfillment.","example":"e4056107-6720-431f-a9f4-fe0ff9b6c92a"},"FulfillmentProduct":{"type":"object","properties":{"itemName":{"description":"The name of the product.","type":"string","example":"Sparkly Sandals"},"itemQuantity":{"allOf":[{"$ref":"#/components/schemas/Quantity"},{"description":"The quantity of this item.","example":4}]},"itemId":{"description":"The id that uniquely identifies the item in the products list.","type":"string","example":"item-id-dcebe01a-a01b-4c4d-b5e7-a2b80b1fcdd7"},"passengerId":{"description":"The id that uniquely identifies the passenger in the passengers list.","type":"string","example":"passenger-id-10b6b931-6ea2-4677-a08c-f6b29c5ed66e"},"airlineTicketFulfillmentStatus":{"description":"Fulfillment method for the airline travel ticket, can be updated to PURCHASED, TICKETED, USED and NO_SHOW. * `PURCHASED` - Ticket has been purchased but not fulfilled / delivered. * `TICKETED` - Ticket has been ticketed / delivered but not used. * `USED` - Ticket was used to board a flight. * `NO_SHOW` - An active ticket was not used to board a flight that has already departed.\n","type":"string","enum":["PURCHASED","TICKETED","USED","NO_SHOW"],"example":"PURCHASED"}},"required":["itemName","itemQuantity"]},"ShipmentStatus":{"enum":["WAITING_FOR_PICKUP","IN_TRANSIT","OUT_FOR_DELIVERY","FAILED_ATTEMPT","DELIVERED","EXCEPTION"],"description":"`needed` Statuses to indicate shipment state.\n  * WAITING_FOR_PICKUP - The carrier has received the request and is about to pick up the shipment.\n  * IN_TRANSIT - The carrier has accepted or picked up shipment.\n  * OUT_FOR_DELIVERY - The carrier is about to deliver the shipment, or it is ready to picked up by the customer.\n  * FAILED_ATTEMPT - The carrier attempted to deliver but failed.\n  * DELIVERED - The shipment was delivered successfully or picked up by the customer successfully.\n  * EXCEPTION - An issue occured while attempting to deliver the shipment (customs hold, undelivered, and returned shipment).","title":"ShipmentStatus","x-sig-description":"`needed` Statuses to indicate shipment state. * WAITING_FOR_PICKUP - The carrier has received the request and is about to pick up the shipment. * IN_TRANSIT - The carrier has accepted or picked up shipment. * OUT_FOR_DELIVERY - The carrier is about to deliver the shipment, or it is ready to picked up by the customer. * FAILED_ATTEMPT - The carrier attempted to deliver but failed. * DELIVERED - The shipment was delivered successfully or picked up by the customer successfully. * EXCEPTION - An issue occured while attempting to deliver the shipment (customs hold, undelivered, and returned shipment).","type":"string","x-sig-needed":true},"BaseFulfillment":{"type":"object","properties":{"fullName":{"description":"The full name of the person receiving the goods. If this item is being shipped, then this field is the person it is being shipping to. If the item is being picked up, then this fields is the person picking up the order. Don't assume this name is the same as `cardHolderName` passed on Checkout or Sale event. Only put a value here if the name will actually appear on the shipping label or name of the pickup person.","type":"string","example":"Bob Smith"},"organization":{"description":"If provided by the buyer, the name of the recipient's company or organization.","type":"string","example":"Initrode plc"}}},"Driver":{"type":"object","description":"The driver information for fulfillments utilizing a Last Mile Delivery company.","properties":{"rating":{"description":"The driver rating as gathered by the Last Mile Delivery company.","type":"number","format":"double"},"fullName":{"description":"The full name of the driver fulfilling the items as seen by the Last Mile Delivery company.","type":"string","example":"Bob Smith"},"id":{"description":"The identifier for the driver fulfilling the items unique to the Last Mile Delivery company.","type":"string"},"vehicleType":{"description":"The driver vehicle type as shared by the Last Mile Delivery company used to fulfill the items. Examples:\n  * SEDAN\n  * HATCHBACK\n  * MINIVAN\n","type":"string","example":"SEDAN"},"vehicleColor":{"description":"The driver vehicle color as shared by the Last Mile Delivery company used to fulfill the items.","type":"string"},"vehicleLicensePlateNumber":{"description":"The driver vehicle license plate number as shared by the Last Mile Delivery company used to fulfill the items.","type":"string"},"device":{"description":"The device data of the driver as seen by the Last Mile Delivery company used to accept the fulfillment request.","allOf":[{"$ref":"#/components/schemas/Device"}]},"expectedDeliveryTime":{"description":"yyyy-MM-dd'T'HH:mm:ssZ The date and time when the items are expected to be fulfilled by the Last Mile Delivery company.","allOf":[{"$ref":"#/components/schemas/DateTime"}]}}},"PhysicalFulfillment":{"title":"PhysicalFulfillment","allOf":[{"$ref":"#/components/schemas/BaseFulfillment"},{"properties":{"address":{"description":"The location where the goods are being shipped.  Required if these are not digital goods.","allOf":[{"$ref":"#/components/schemas/Address"}]},"confirmationPhone":{"description":"If the item was picked up at a physical location, the phone number of the store or business the item was picked up from.","type":"string","example":"+442071838750"},"driver":{"$ref":"#/components/schemas/Driver"}}}]},"DigitalFulfillment":{"title":"EmailFulfillment","allOf":[{"$ref":"#/components/schemas/BaseFulfillment"},{"properties":{"email":{"description":"Email address where the goods are being delivered. Only use for digital goods.","type":"string","format":"email","nullable":false,"example":"bob@example.com"}}}]},"FulfillmentRecipient":{"oneOf":[{"$ref":"#/components/schemas/PhysicalFulfillment"},{"$ref":"#/components/schemas/DigitalFulfillment"}]},"Carrier":{"type":"string","description":"`needed` The name of the Shipper. It is strongly recommended that one of the values from the  [supported carrier list](https://community.signifyd.com/support/s/article/shipping-carrier-list)  along with the tracking number in the trackingNumbers field are passed, as they are required to process  chargebacks and claims. However, If you are unable to pass either tracking number or carrier and if the  carrier name is not on the list please ensure you pass a tracking URL in the trackingURLs field or reach  out to your Implementation Manager to understand alternatives to ensure we are able to process your  chargebacks and claims.\n  * `Fedex`\n  * `DHL Express`\n  * `USPS`\n  * `UPS`\n  * `LaserShip`\n  * `DoorDash`","example":"UPS","x-sig-needed":true},"Shipments":{"required":["destination"],"description":"Details about the delivery destinations.","type":"object","properties":{"destination":{"description":"Information about the person and location where the goods are being shipped.","$ref":"#/components/schemas/FulfillmentRecipient"},"origin":{"description":"Information about the location from which the shipment originated.","title":"Origin","type":"object","properties":{"locationId":{"description":"Merchant's internal unique identifier for the location, such as a store or a fulfillment center.","type":"string","example":"boise-store-24"},"address":{"$ref":"#/components/schemas/Address"}}},"carrier":{"$ref":"#/components/schemas/Carrier"},"fulfillmentMethod":{"$ref":"#/components/schemas/FulfillmentMethodEnum"}}},"Fulfillment":{"title":"Fulfillment","type":"object","required":["shipmentId","deliveredAt"],"allOf":[{"properties":{"shipmentId":{"$ref":"#/components/schemas/ShipmentId"},"shippedAt":{"description":"`needed` The date and time items are ready to be shipped. Formatted as `yyyy-MM-dd'T'HH:mm:ssZ` See the dates section of the Introduction for more information about date formats.","type":"string","x-sig-needed":true,"format":"date-time"},"products":{"description":"The list of products that were included in the shipment.","items":{"$ref":"#/components/schemas/FulfillmentProduct"},"type":"array"},"shipmentStatus":{"$ref":"#/components/schemas/ShipmentStatus"},"trackingUrls":{"description":"`needed` The tracking URLs for the shipment as provided by the shipping carrier.","items":{"type":"string","example":"http://wwwapps.ups.com/etracking/123"},"type":"array","x-sig-needed":true},"trackingNumbers":{"description":"`needed` The tracking number(s) for the shipment as provided by the shipping carrier. It is strongly recommended that this value along with the name of the Shipper in the carrier field are passed, as they  are required to process chargebacks and claims. However, If you are unable to pass either tracking number  or carrier please ensure you pass a tracking URL in the trackingURLs field or reach out to your  Implementation Manager to understand alternatives to ensure we are able to process your chargebacks and claims.","items":{"type":"string","example":"TBA005492092203"},"type":"array","x-sig-needed":true}}},{"$ref":"#/components/schemas/Shipments"}]},"Fulfillments":{"properties":{"orderId":{"description":"The id that uniquely identifies the order the shipment is for. This should be the same orderId provided when created by Checkout or Sale event.","type":"string","example":"XGR-1840823423"},"fulfillmentStatus":{"$ref":"#/components/schemas/FulfillmentStatus"},"fulfillments":{"description":"A list of fulfillments associated with an order.","items":{"$ref":"#/components/schemas/Fulfillment"},"type":"array"}},"title":"Fulfillments","type":"object","required":["orderId","fulfillments"]},"FulfillmentResponse":{"title":"FulfillmentResponse","required":["orderId","shipmentIds"],"properties":{"orderId":{"description":"The id that uniquely identifies the order the shipment is for. This should be the same orderId provided when created by Checkout or Sale event.","type":"string"},"shipmentIds":{"description":"The list of `shipmentId`s associated with this order.","items":{"$ref":"#/components/schemas/ShipmentId"},"type":"array"},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"WebhookTopic":{"title":"topic","type":"string","enum":["ORDER_CHECKPOINT_ACTION_UPDATE"]},"WebhookUrl":{"title":"url","description":"The URL to which the webhook data should be sent when the event is triggered.","type":"string","format":"uri","example":"http://knickknacks.examplepartner.com/signifydWebhook.php"},"WebhookDetails":{"type":"object","properties":{"id":{"description":"Signifyd's unique identifier for the webhook.","type":"string","example":"00071eb8-468c-4176-b7cc-dc2876ee6b4f"},"topic":{"$ref":"#/components/schemas/WebhookTopic"},"url":{"$ref":"#/components/schemas/WebhookUrl"},"createdAt":{"description":"Timestamp at which the webhook was created.","type":"string","example":"2020-08-27T23:22:00.249997Z"},"updatedAt":{"description":"Timestamp at which the webhook was last updated.","type":"string","example":"2020-08-27T23:22:00.249997Z"}}},"WebhookArrayResponse":{"title":"Webhooks Response","type":"array","items":{"$ref":"#/components/schemas/WebhookDetails"}},"Webhook":{"type":"object","properties":{"url":{"$ref":"#/components/schemas/WebhookUrl"}},"required":["url"]},"WebhookCreateRequest":{"title":"Create Webhook Request","$ref":"#/components/schemas/Webhook"},"WebhookResponse":{"title":"Webhook Response","$ref":"#/components/schemas/WebhookDetails"},"ApiVersion":{"title":"apiVersion","type":"string","enum":["V2","V3","ALL"],"example":"ALL"},"GetWebhookRequest":{"title":"Get Webhook Request","required":["teamIds","version"],"properties":{"teamIds":{"type":"array","items":{"type":"integer","format":"int64","example":567890}},"version":{"$ref":"#/components/schemas/ApiVersion"}}},"WebhookEventTopic":{"title":"event or topic","type":"string","enum":["ORDER_CHECKPOINT_ACTION_UPDATE","CASE_CREATION","CASE_RESCORE","CASE_REVIEW","DECISION_MADE","GUARANTEE_COMPLETION","GUARANTEE_INELIGIBLE","CLAIM_REVIEWED","CLAIM_PAYOUT"]},"WebhookFullDetails":{"type":"object","properties":{"id":{"description":"Signifyd's unique identifier for the webhook.","type":"string","example":"00071eb8-468c-4176-b7cc-dc2876ee6b4f"},"topic":{"$ref":"#/components/schemas/WebhookEventTopic"},"url":{"$ref":"#/components/schemas/WebhookUrl"},"apiVersion":{"$ref":"#/components/schemas/ApiVersion"},"teamId":{"description":"Signifyd's unique identifier for the webhooks team.","type":"integer","format":"int64","example":12345},"teamName":{"description":"The name of the team to which the webhook belongs.","type":"string","example":"Team Name"},"createdAt":{"description":"Timestamp at which the webhook was created.","type":"string","format":"date-time","example":"2020-08-27T23:22:00.249997Z"},"updatedAt":{"description":"Timestamp at which the webhook was last updated.","type":"string","format":"date-time","example":"2020-08-27T23:22:00.249997Z"}}},"VersionedWebhookResponse":{"title":"Webhooks Response","type":"array","items":{"$ref":"#/components/schemas/WebhookFullDetails"}},"WebhookUpdateRequest":{"title":"Update Webhook Request","$ref":"#/components/schemas/Webhook"},"SessionIntelligenceRequestDevice":{"type":"object","title":"SessionIntelligenceRequestDevice","properties":{"clientIpAddress":{"type":"string","description":"The client IP you observed for this session, used as an additional signal in the response.","example":"203.0.113.7"},"originatingUserAgent":{"type":"string","description":"The client user agent you observed for this session, used as an additional signal in the response."}}},"SessionIntelligenceRequest":{"type":"object","title":"SessionIntelligenceRequest","description":"Optional server-observed device hints supplied by the merchant backend. All fields are optional and the request body may be omitted entirely.","properties":{"device":{"$ref":"#/components/schemas/SessionIntelligenceRequestDevice"}}},"SessionResponse":{"type":"object","title":"SessionResponse","description":"API call metadata.","required":["sessionId","profileStatus"],"properties":{"sessionId":{"type":"string","description":"The session id this response is for."},"profileStatus":{"type":"string","description":"PROFILED when a device profile was found for the session, otherwise NOT_PROFILED. A well-formed but unknown or not-yet-profiled session returns HTTP 200 with a null device and NOT_PROFILED.","enum":["PROFILED","NOT_PROFILED"]},"altDomain":{"type":"string","description":"Alternate host and path used to submit the profiling payload through a merchant reverse proxy; null when the standard Signifyd profiling endpoint was used.","nullable":true}}},"DeviceIdentity":{"type":"object","title":"DeviceIdentity","description":"Device and session identifiers.","properties":{"sessionId":{"type":"string","description":"The session id the device was profiled under, lower-cased. For a mixed-case id this differs in case from sessionResponse.sessionId, which echoes the id you supplied; lookups are case-insensitive.","nullable":true},"deviceId":{"type":"string","description":"Signifyd device identifier for the profiled session; null when no device id was resolved for the session.","nullable":true},"normalizedDeviceId":{"type":"string","description":"Canonical RFC 4122 form of deviceId; null when deviceId is absent or is not a valid UUID, including the all-zeros UUID.","nullable":true},"fuzzyBrowserId":{"type":"string","description":"Probabilistic browser fingerprint based on browser characteristics (user agent, screen, fonts, plugins, and similar). Can be shared across devices with similar configurations.","nullable":true},"cryptoBrowserId":{"type":"string","description":"Cryptographic browser fingerprint derived from device and browser signals. More stable and more unique per device than fuzzyBrowserId.","nullable":true}}},"DeviceHistory":{"type":"object","title":"DeviceHistory","description":"Timestamps indicating when identifiers were first and last seen.","properties":{"profileTime":{"type":"string","format":"date-time","description":"Time that the session was most recently profiled.","nullable":true},"sessionLastProfiled":{"type":"string","format":"date-time","description":"Time that the session was profiled immediately before profileTime; equal to profileTime when this is the session's first profiling event.","nullable":true},"deviceFirstSeen":{"type":"string","format":"date-time","description":"First time the device was seen.","nullable":true},"fuzzyIdFirstSeen":{"type":"string","format":"date-time","description":"First time the fuzzyBrowserId was seen.","nullable":true},"cryptoIdFirstSeen":{"type":"string","format":"date-time","description":"First time the cryptographic browser id was seen.","nullable":true}}},"DeviceClient":{"type":"object","title":"DeviceClient","description":"SDK/client classification, web browser versus native app and desktop versus mobile.","properties":{"clientType":{"type":"string","description":"Client classification, for example CLIENT_TYPE_WEB_BROWSER or CLIENT_TYPE_NATIVE_APP.","nullable":true},"deviceType":{"type":"string","description":"Device classification, for example DEVICE_TYPE_DESKTOP or DEVICE_TYPE_MOBILE.","nullable":true},"clientVersion":{"type":"string","description":"Client/SDK version; populated for native-app sessions and null on the web.","nullable":true},"deviceModel":{"type":"string","description":"Device model, for example Pixel 6; populated for native-app sessions and null on the web.","nullable":true}}},"DeviceBrowser":{"type":"object","title":"DeviceBrowser","description":"Browser and operating-system signals.","properties":{"userAgent":{"type":"string","description":"User-Agent reported by the client.","nullable":true},"browserName":{"type":"string","description":"Browser name, for example Chrome. Native-app sessions report Android App or iOS App.","nullable":true},"browserLanguage":{"type":"string","description":"Language/locale reported by the browser, for example en-US.","nullable":true},"navigatorOperatingSystem":{"type":"string","description":"Operating system reported by the client runtime (navigator).","nullable":true},"userAgentOperatingSystem":{"type":"string","description":"Operating system parsed from the User-Agent string.","nullable":true},"osVersion":{"type":"string","description":"Operating-system version.","nullable":true}}},"DeviceDisplay":{"type":"object","title":"DeviceDisplay","description":"Screen resolution and orientation.","properties":{"screenResolution":{"type":"string","description":"Screen resolution in pixels, reported shorter-edge-first (for example a 2560x1440 display is returned as \"1440x2560\").","nullable":true},"orientation":{"type":"string","description":"Screen orientation reported by the device: ORIENTATION_PORTRAIT, ORIENTATION_LANDSCAPE or ORIENTATION_OTHER (for example a device lying face-up, or a value the browser did not recognize). Null when the device reported no orientation.","nullable":true}}},"DeviceEnvironment":{"type":"object","title":"DeviceEnvironment","description":"Browser environment settings.","properties":{"cookiesEnabled":{"type":"boolean","description":"Whether cookies are enabled in the client.","nullable":true},"privateBrowsingMode":{"type":"string","description":"Private browsing state, for example PRIVATE_BROWSING_MODE_ENABLED, PRIVATE_BROWSING_MODE_DISABLED or PRIVATE_BROWSING_MODE_NOT_APPLICABLE.","nullable":true},"flashEnabled":{"type":"boolean","description":"Whether Flash is enabled. Always false; retained for backward compatibility and not a signal to act on.","nullable":true}}},"DeviceTimezone":{"type":"object","title":"DeviceTimezone","description":"Timezone signals the device reported, alongside the values Signifyd resolved for comparison.","properties":{"zone":{"type":"string","description":"Time zone name reported by the device, for example Central European Summer Time.","nullable":true},"location":{"type":"string","description":"Location reported by the device, for example Europe, Berlin.","nullable":true},"locationMeasured":{"type":"string","description":"Location Signifyd resolved for the session, for comparison against the reported location. Always matches location on native-app sessions.","nullable":true},"offset":{"type":"integer","format":"int32","description":"Time zone offset reported by the device, in minutes, in the JavaScript getTimezoneOffset() convention (the negative of the UTC offset; e.g. UTC-5 gives 300).","nullable":true},"offsetComputed":{"type":"integer","format":"int32","description":"UTC offset Signifyd resolved for the session, in minutes east of UTC - opposite sign to offset (UTC-5 gives -300). On a consistent device, offset + offsetComputed is approximately 0. On native-app sessions, 0 when the device reported no recognizable time zone, so 0 does not by itself mean UTC.","nullable":true}}},"DeviceBattery":{"type":"object","title":"DeviceBattery","description":"Battery charge signals.","properties":{"level":{"type":"number","format":"float","description":"Battery charge level from 0.0 to 1.0.","nullable":true},"status":{"type":"string","description":"Charging state, for example BATTERY_STATUS_CHARGING or BATTERY_STATUS_DISCHARGING.","nullable":true}}},"DeviceIp":{"type":"object","title":"DeviceIp","description":"IP identity data for the session.","properties":{"trueIp":{"type":"string","description":"Device IP discovered client-side via WebRTC (IPv4 when available, otherwise IPv6). Client-derived, so treat it as a signal rather than an authoritative value; see clientIp for the server-observed IP. Null for native-app sessions and whenever WebRTC yields no usable address, including when the browser blocks WebRTC (also reported as a webRTC_blocked anomaly).","nullable":true},"clientIp":{"type":"string","description":"The IP address observed server-side on the session's profiling request.","nullable":true},"ipFirstSeen":{"type":"string","format":"date-time","description":"First time this IP was seen.","nullable":true}}},"DeviceReferrer":{"type":"object","title":"DeviceReferrer","description":"Information about the referrer that led to the profiled page. url is the referrer as reported by the client; origin and domain are derived from it. The object is always present, with all three fields null for native-app sessions and for web sessions that had no referrer.","properties":{"url":{"type":"string","description":"Referrer reported for the web session, as document.referrer. Null when the page had no referrer, such as a direct visit. Reported verbatim, so it is not guaranteed to be a parseable absolute URL.","nullable":true},"origin":{"type":"string","description":"Scheme and host derived from url, for example https://www.google.com. Null when the url is null or is not an absolute URL.","nullable":true},"domain":{"type":"string","description":"Host derived from url, for example www.google.com. Null when the url is null or is not an absolute URL.","nullable":true}}},"DeviceAgentic":{"type":"object","title":"DeviceAgentic","description":"Agentic traffic detection via behavioral signals and RFC 9421 HTTP Message Signatures, and whether the session arrived from an AI assistant's referrer.","properties":{"isAgentic":{"type":"boolean","description":"True when the session is attributed to an AI agent or automated client.","nullable":true},"agentName":{"type":"string","description":"Name of the detected agent, when known.","nullable":true},"confidence":{"type":"number","format":"float","description":"Confidence score for the agentic assessment, from 0.0 to 1.0.","nullable":true},"signatureAgent":{"type":"string","description":"Agent identified from the HTTP Signature-Agent header.","nullable":true},"signature":{"type":"string","description":"Value of the HTTP Signature header used for agent verification.","nullable":true},"signatureInput":{"type":"string","description":"Value of the HTTP Signature-Input header used for agent verification.","nullable":true},"referrerIsAgentic":{"type":"boolean","description":"True when the session arrived from a known AI assistant, detected from the referrer domain (for example chatgpt.com or perplexity.ai). Kept for the rest of the session once detected. False or null when no AI-assistant referrer was detected.","nullable":true},"referrerAgentName":{"type":"string","description":"Provider of the AI assistant detected from the referrer, for example openai or perplexity. Null unless referrerIsAgentic is true.","nullable":true}}},"DeviceBotDetection":{"type":"object","title":"DeviceBotDetection","description":"Automated-client detection for the session, with the signals behind the assessment.","properties":{"isBot":{"type":"boolean","description":"True when the session shows evidence of an automated client.","nullable":true},"confidence":{"type":"number","format":"float","description":"Confidence in the isBot assessment, from 0.0 to 1.0, where higher values mean greater confidence in the reported isBot value.","nullable":true},"signals":{"type":"array","description":"A list of the most important signals that produced a true value for the isBot field. Empty when isBot is false, and may also be empty when isBot is true if no individual signal was recorded for the session. The currently supported values are WEBDRIVER, CRAWLER_UA, and UA_MISMATCH. This is deliberately not a closed set: the list of possible values may change over time, so treat an unrecognized value as a signal your integration does not handle rather than as an error.","items":{"type":"string","example":"WEBDRIVER"}}}},"DeviceIntegrity":{"type":"object","title":"DeviceIntegrity","description":"Device integrity and spoofing signals.","properties":{"ipMismatch":{"type":"boolean","description":"True when the WebRTC IP differed from the server-observed IP on the most recent profiling request that had both, of the same IP version. Requests without such a pair leave the value unchanged, so it can describe an earlier page view than the one ip.trueIp and ip.clientIp come from, and it can be set while ip.trueIp is null. A later match overwrites an earlier mismatch, so false does not rule out a mismatch earlier in the session; compare navigationHistory.pageViews[].trueIp with clientIp for that. The two can legitimately differ (for example on cellular networks or behind corporate proxies), so treat this as a signal rather than a fraud determination. The WebRTC IP is client-reported and can be manipulated, so false does not prove the IPs match and should not be used on its own to clear a session. Null for native-app sessions and when no request in the session had a comparable pair (for example WebRTC blocked throughout, or an IPv4 WebRTC IP with an IPv6 server-observed IP).","nullable":true},"rooted":{"type":"boolean","description":"True when the device is rooted. Null for non-mobile-app sessions.","nullable":true},"emulator":{"type":"boolean","description":"True when the device is an emulator. Null for non-mobile-app sessions.","nullable":true},"debuggable":{"type":"boolean","description":"True when the app is debuggable. Null for non-mobile-app sessions.","nullable":true},"lieCount":{"type":"integer","format":"int32","description":"Count of detected inconsistencies (\"lies\") between reported and measured device attributes. Web signals only; 0 for native-app sessions. Null means no count was recorded - not the same as 0, so do not coerce it to 0.","nullable":true},"majorLieCount":{"type":"integer","format":"int32","description":"Count of major lies (the subset severe enough to be named individually in anomalies). Web signals only; 0 for native-app sessions. Null means no count was recorded - not the same as 0, so do not coerce it to 0.","nullable":true},"anomalies":{"type":"array","description":"Named anomalies for the session: major lies plus any named profile signals (such as webRTC_blocked), which are reported regardless of severity. Can be non-empty when majorLieCount is 0, and empty when lieCount is non-zero, so an empty array does not mean no lies were detected. Treat entries as opaque labels for review; use lieCount and majorLieCount for counts. Empty for native-app sessions.","items":{"type":"string"}}}},"PageView":{"type":"object","title":"PageView","description":"A single page view recorded during the session.","properties":{"url":{"type":"string","description":"URL of the visited page; null when not captured.","nullable":true},"trueIp":{"type":"string","description":"IP discovered client-side via WebRTC on the profiling request for this page view. Client-reported, so treat it as a signal; compare with clientIp to see whether this page view had an IP mismatch. Null for native-app page views, when WebRTC yielded no address (for example when the browser blocks it), and for page views recorded before this field was introduced. Never falls back to the server-observed IP.","nullable":true},"clientIp":{"type":"string","description":"The IP address observed server-side on the profiling request for this page view. Null when not captured, including page views recorded before this field was introduced.","nullable":true},"userAgent":{"type":"string","description":"User-Agent header of the profiling request for this page view; null when not captured.","nullable":true},"visitedAt":{"type":"string","format":"date-time","description":"Time Signifyd received the profiling request for this page. Later than the moment the visitor arrived by however long the page took to load and profile, so treat it as approximate.","nullable":true},"timeOnPageSeconds":{"type":"integer","format":"int32","description":"Approximate seconds between this page view and the next page the visitor moved to, which is the previous entry in the array. Derived from the gap between profiling requests rather than measured on the page, so it is only meaningful when Signifyd profiles every page the visitor sees. Where a page is not profiled, its time is attributed to the page before it. Null on the most recent page view, which has nothing after it to measure against, when a timestamp is missing, and on native-app sessions.","nullable":true}}},"NavigationHistory":{"type":"object","title":"NavigationHistory","description":"Page views recorded during the session.","properties":{"pageViews":{"type":"array","description":"The page views recorded for the session; empty when none were captured.","items":{"$ref":"#/components/schemas/PageView"}}}},"DeviceWifi":{"type":"object","title":"DeviceWifi","description":"Wi-Fi identifiers for the connected network (mobile sessions).","properties":{"ssid":{"type":"string","description":"Wi-Fi network name (SSID).","nullable":true},"bssid":{"type":"string","description":"Wi-Fi access-point hardware address (BSSID).","nullable":true}}},"DeviceGeoLocation":{"type":"object","title":"DeviceGeoLocation","description":"Device geolocation, available from mobile app traffic with location permission enabled.","properties":{"latitude":{"type":"number","format":"double","description":"Latitude of the geolocation fix, in decimal degrees.","nullable":true},"longitude":{"type":"number","format":"double","description":"Longitude of the geolocation fix, in decimal degrees.","nullable":true},"accuracy":{"type":"number","format":"float","description":"Estimated accuracy of the fix, in meters.","nullable":true},"provider":{"type":"string","description":"Location provider that produced the fix (Android); null on iOS.","nullable":true}}},"DeviceIntelligence":{"type":"object","title":"DeviceIntelligence","description":"Device intelligence groups mapped from the profiled session.","properties":{"identity":{"$ref":"#/components/schemas/DeviceIdentity"},"deviceHistory":{"$ref":"#/components/schemas/DeviceHistory"},"client":{"$ref":"#/components/schemas/DeviceClient"},"browser":{"$ref":"#/components/schemas/DeviceBrowser"},"display":{"$ref":"#/components/schemas/DeviceDisplay"},"environment":{"$ref":"#/components/schemas/DeviceEnvironment"},"timezone":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/DeviceTimezone"}]},"battery":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/DeviceBattery"}]},"ip":{"$ref":"#/components/schemas/DeviceIp"},"referrer":{"$ref":"#/components/schemas/DeviceReferrer"},"agentic":{"description":"Agentic traffic detection via behavioral signals and RFC 9421 HTTP Message Signatures. Present only when an agentic assessment was produced; null otherwise.","nullable":true,"allOf":[{"$ref":"#/components/schemas/DeviceAgentic"}]},"botDetection":{"description":"Automated-client detection. Derived from web signals only, so this is null for native-app sessions and for any session device intelligence did not assess.","nullable":true,"allOf":[{"$ref":"#/components/schemas/DeviceBotDetection"}]},"integrity":{"$ref":"#/components/schemas/DeviceIntegrity"},"navigationHistory":{"$ref":"#/components/schemas/NavigationHistory"},"wifi":{"description":"Wi-Fi identifiers for the connected network, reported for mobile sessions. Null on web/desktop or when the mobile OS withholds the network.","nullable":true,"allOf":[{"$ref":"#/components/schemas/DeviceWifi"}]},"geoLocation":{"description":"Device geolocation, available from mobile app traffic with location permission enabled. Null on web/desktop or when unavailable.","nullable":true,"allOf":[{"$ref":"#/components/schemas/DeviceGeoLocation"}]}}},"SessionIntelligenceResponse":{"type":"object","title":"SessionIntelligenceResponse","required":["sessionResponse"],"properties":{"sessionResponse":{"$ref":"#/components/schemas/SessionResponse"},"device":{"description":"The device profile, or null when the session has not been profiled.","nullable":true,"allOf":[{"$ref":"#/components/schemas/DeviceIntelligence"}]}}}},"parameters":{"TeamIdHeader":{"in":"header","name":"SIGNIFYD-TEAM-ID","description":"The team id requested for authentication. This should normally be omitted, as it's only relevant when auth credentials allow requests for multiple teams.","schema":{"type":"integer","format":"int64","example":789123},"required":false},"AccountIntegrityTestDecisionHeader":{"in":"header","name":"SIGNIFYD-TEST-DECISION-RESPONSE","description":"Override the decision response for testing Account Integrity API integrations.\nThis header allows you to specify the exact decision you want returned, bypassing normal \ndecision processing. Only valid for test teams.\n\nAvailable actions:\n* `ALLOW` - Let the event proceed normally. No additional checks are needed.\n* `DENY` - Reject the event outright and do not persist or apply the change.\n* `STEP_UP` - Pause the flow and require extra verification (for example, MFA or a challenge).\n* `FLAG` - Allow the event. Signifyd will use this flag in downstream flows like checkout to apply added scrutiny where needed.\n* `ALERT` - Allow the event but immediately notify the user of unusual activity (for example, via email or SMS).\n","schema":{"type":"string","enum":["ALLOW","DENY","STEP_UP","FLAG","ALERT"]},"required":false}},"responses":{"BadRequest":{"description":"Response if there was a problem with the request, such as when a required field is missing or otherwise fails validation.","content":{"application/json":{"schema":{"required":["messages","traceId","errors"],"allOf":[{"$ref":"#/components/schemas/GenericErrorBodyWithErrorDetails"}]}}}},"UnauthorizedWithErrorDetails":{"description":"Response if the provided authentication credentials are not known or do not match what is on file for the specified user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBodyWithErrorDetails"}}}},"ForbiddenWithErrorDetails":{"description":"Response if the authenticated user does not have permission to perform the requested action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBodyWithErrorDetails"}}}},"NotFoundWithErrorDetails":{"description":"Response if the requested entity can't be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBodyWithErrorDetails"}}}},"ServerError":{"description":"Response if an unexplained error occurs on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"NoContent":{"description":"A 204 response indicates that the request was processed but no response is expected."},"Conflict":{"description":"Response if the Request is considered to conflict with data already on the system.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"ConflictWithErrorDetails":{"description":"Response if the Request is considered to conflict with data already on the system.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBodyWithErrorDetails"}}}},"Unauthorized":{"description":"Response if the provided authentication credentials are not known or do not match what is on file for the specified user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"Forbidden":{"description":"Response if the authenticated user does not have permission to perform the requested action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"TooManyRequests":{"description":"Response if the rate limit has been exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"NotFound":{"description":"Response if the requested entity can't be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericErrorBody"}}}},"OrderNotFound":{"description":"Response if the requested entity can't be found. <br /> This indicates Signifyd could not match the request to an order in the system.","content":{"application/json":{"schema":{"title":"OrderNotFound","type":"object","required":["messages","traceId","errors"],"properties":{"messages":{"type":"array","description":"Messages describing the error.","items":{"type":"string","example":"Signifyd could not match the request to an order."}},"traceId":{"type":"string","description":"If there is an error and you would like to contact Signifyd, please include this id in your support request.","example":"891f2e31d267dde"}}}}}},"ConflictDuplicateChargeback":{"description":"Response if the Request is considered to conflict with data already on the system. <br /> This indicates the request contains details of a chargeback that already exists.","content":{"application/json":{"schema":{"title":"ConflictDuplicateChargeback","type":"object","required":["messages","traceId","errors"],"properties":{"messages":{"type":"array","description":"Messages describing the error.","items":{"type":"string","example":"The request contains details of a chargeback that already exists."}},"traceId":{"type":"string","description":"If there is an error and you would like to contact Signifyd, please include this id in your support request.","example":"891f2e31d267dde"},"errors":{"type":"object","title":"InvalidFields","description":"If an error has occurred due to a specific request field, this will be highlighted in this section of the response.","example":{"purchase.discountCodes[0].code":"missing"},"additionalProperties":{"type":"string","description":"With the key being a json path to the invalid field, this describes what is wrong with the field."}}}}}}},"ChargebackNotFound":{"description":"Response if the requested entity can't be found. <br /> This indicates Signifyd could not match the request to a chargeback in the system.","content":{"application/json":{"schema":{"title":"ChargebackNotFound","type":"object","required":["messages","traceId","errors"],"properties":{"messages":{"type":"array","description":"Messages describing the error.","items":{"type":"string","example":"Signifyd could not match the request to a chargeback."}},"traceId":{"type":"string","description":"If there is an error and you would like to contact Signifyd, please include this id in your support request.","example":"891f2e31d267dde"}}}}}},"ConflictCurrentStage":{"description":"Response if the Request is considered to conflict with data already on the system. <br /> This indicates the requested Stage change does not change the current Chargeback Stage.","content":{"application/json":{"schema":{"title":"ConflictCurrentStage","type":"object","required":["messages","traceId","errors"],"properties":{"messages":{"type":"array","description":"Messages describing the error.","items":{"type":"string","example":"The requested Stage change does not change the current Chargeback Stage."}},"traceId":{"type":"string","description":"If there is an error and you would like to contact Signifyd, please include this id in your support request.","example":"891f2e31d267dde"},"errors":{"type":"object","title":"InvalidFields","description":"If an error has occurred due to a specific request field, this will be highlighted in this section of the response.","example":{"purchase.discountCodes[0].code":"missing"},"additionalProperties":{"type":"string","description":"With the key being a json path to the invalid field, this describes what is wrong with the field."}}}}}}}}},"x-tagGroups":[{"name":"Commerce","tags":["Purchases","Purchase Management","Chargebacks","Returns & Appeasements"]},{"name":"Legacy Returns","tags":["Return"]},{"name":"Webhooks","tags":["Webhook Events","Webhook Management"]},{"name":"Accounts","tags":["Openings","Modifications","Logins","AccountCheckouts"]},{"name":"Partners","tags":["Partners","Organizations","Teams","Users"]},{"name":"Device Intelligence","tags":["Session Intelligence"]}]}