Create Intake Case

​

Starts a dispute case on a transaction your application has already chosen, so the embedded experience opens on that transaction instead of asking the customer to find it. Identify the customer with customer.uuid and name the transaction with transactionId. Sending both transactionId and transactions is rejected. The returned intakeCaseId is what you pass as the intakeRef claim when you authenticate.

Body·

required
application/json
  • Properties: 7
  • DisputeReason is the dispute reason category. GetDisputeReasons returns the applicable parent categories; the specific sub-reason is resolved server-side from the questionnaire answers at Create time, so callers only ever submit a parent reason. Legacy reason values are normalized to this set before they reach the API, so these are the only values integrators see.

    • DISPUTE_REASON_ACH_ISSUE: Unauthorized ACH debit. Other ACH problems use the more specific DISPUTE_REASON_ACH_* values.
    • DISPUTE_REASON_ACH_CREDIT_ISSUE: Dispute about an ACH credit (incoming or outgoing credit entry), as opposed to the ACH_ISSUE_* family, which covers consumer debit disputes.
    values
    • DISPUTE_REASON_UNKNOWN
    • DISPUTE_REASON_UNAUTH
    • DISPUTE_REASON_MERCHANT_ISSUE
    • DISPUTE_REASON_ATM_ISSUE
    • DISPUTE_REASON_ACH_ISSUE
    • DISPUTE_REASON_TRANSFER_ISSUE
    • DISPUTE_REASON_ATM_ISSUE_CASH_NOT_DISPENSED
    • DISPUTE_REASON_MERCHANT_ISSUE_GOODS_OR_SERVICES_NOT_RECEIVED
  • Properties: 18

Responses

  • application/json
  • application/json
Request Example for post/v1/intakes
curl /v1/intakes \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data '{
  "customer": {
    "accountUuid": "",
    "address": {
      "city": "",
      "country": "",
      "line1": "",
      "line2": "",
      "postalCode": "",
      "state": ""
    },
    "email": "",
    "externalIds": {
      "additionalProperty": ""
    },
    "name": "",
    "phone": "",
    "uuid": ""
  },
  "disputeReason": "DISPUTE_REASON_UNKNOWN",
  "orgUuid": "",
  "transactionId": "",
  "transactions": [
    {
      "amount": {
        "amountInCents": 1,
        "currency": ""
      },
      "arn": "",
      "authorizedTimestamp": "",
      "cardId": "",
      "cardLast4": "",
      "cardType": "CARD_TYPE_UNKNOWN",
      "ica": "",
      "location": "",
      "merchant": "",
      "network": "TRANSACTION_NETWORK_UNKNOWN",
      "rrn": "",
      "settledTimestamp": "",
      "status": "TRANSACTION_STATUS_UNKNOWN",
      "transactionSettledAmount": {
        "amountInCents": 1,
        "currency": ""
      },
      "type": "TRANSACTION_TYPE_UNKNOWN",
      "typeCode": "",
      "uuid": "",
      "visaTransactionId": ""
    }
  ]
}'
{
  "intakeCaseId": "string"
}