Dispute Categories¶

Retrieving a Category by Code¶

Swagger Page¶

https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1#/DisputeCategoryV1/get_v1_tenants__tenantId__categories_code__code_

Permission¶

Dispute Configuration : READ

Example Request¶

curl -X GET 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/categories/code/{categoryCode}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'

Example Response¶

{
  "categoryId": "{categoryId}",
  "tenantId": "{tenantId}",
  "code": "{categoryCode}",
  "description": "Shipping Mistakes",
  "defaultInternalReasonId": "{defaultInternalReasonId}",
  "defaultInternalReasonCode": "{defaultInternalReasonCode}",
  "defaultExternalReasonId": "{defaultExternalReasonId}",
  "defaultExternalReasonCode": "{defaultExternalReasonCode}",
  "createUser": "{userId}",
  "createDate": "2021-03-28T15:30:21.242Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T15:30:21.242Z"
}

Retrieving a List of Categories¶

Swagger Page¶

https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1#/DisputeCategoryV1/get_v1_tenants__tenantId__categories

Permission¶

Dispute Configuration : READ

Example Request¶

curl -X GET 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/categories' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'

Example Response¶

[
  {
    "categoryId": "{categoryId}",
    "tenantId": "{tenantId}",
    "code": "SHIPPING",
    "description": "Shipping Mistakes",
    "defaultInternalReasonId": "{defaultInternalReasonId}",
    "defaultInternalReasonCode": "{defaultInternalReasonCode}",
    "defaultExternalReasonId": "{defaultExternalReasonId}",
    "defaultExternalReasonCode": "{defaultExternalReasonCode}",
    "createUser": "{userId}",
    "createDate": "2021-03-28T15:30:21.242Z",
    "updateUser": "{userId}",
    "updateDate": "2021-03-28T15:30:21.242Z"
  },
    ...
]

Creating a Category¶

Swagger Page¶

https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1#/DisputeCategoryV1/post_v1_tenants__tenantId__categories

Permission¶

Dispute Configuration : CREATE

Example Request¶

curl -X POST 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/categories' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "code": "SHIPPING", "description": "Shipping Mistakes",  "defaultInternalReasonId": "{defaultInternalReasonId}", "defaultExternalReasonId": "{defaultExternalReasonId}" }'

Example Response¶

{
  "categoryId": "{categoryId}",
  "tenantId": "{tenantId}",
  "code": "SHIPPING",
  "description": "Shipping Mistakes",
  "defaultInternalReasonId": "{defaultInternalReasonId}",
  "defaultInternalReasonCode": "{defaultInternalReasonCode}",
  "defaultExternalReasonId": "{defaultExternalReasonId}",
  "defaultExternalReasonCode": "{defaultExternalReasonCode}",
  "createUser": "{userId}",
  "createDate": "2021-03-28T15:30:21.242Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-28T15:30:21.242Z"
}

Updating a Category¶

Swagger Page¶

https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1#/DisputeCategoryV1/put_v1_tenants__tenantId__categories__categoryId_

Permission¶

Dispute Configuration : UPDATE

Example Request¶

curl -X PUT 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/categories/{categoryId}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>' \
    -d '{ "description": "Shipping Errors", "defaultInternalReasonId": "{defaultInternalReasonId}", "defaultExternalReasonId": "{defaultExternalReasonId}" }'

Example Response¶

{
  "categoryId": "{categoryId}",
  "tenantId": "{tenantId}",
  "code": "SHIPPING",
  "description": "Shipping Errors",
  "defaultInternalReasonId": "{defaultInternalReasonId}",
  "defaultInternalReasonCode": "{defaultInternalReasonCode}",
  "defaultExternalReasonId": "{defaultExternalReasonId}",
  "defaultExternalReasonCode": "{defaultExternalReasonCode}",
  "createUser": "{userId}",
  "createDate": "2021-03-28T15:30:21.242Z",
  "updateUser": "{userId}",
  "updateDate": "2021-03-30T12:12:00.000Z"
}

Deleting a Category¶

Swagger Page¶

https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1#/DisputeCategoryV1/delete_v1_tenants__tenantId__categories_by_code__categoryCode_

Permission¶

Dispute Configuration : DELETE

Example Request¶

curl -X DELETE 'https://arc-aegis.billtrust.com/dispute/v1/tenants/{tenantId}/categories/by-code/{categoryCode}' \
    -H 'accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'