Authentication
Authenticate with the API using your identity provider's JWT to receive a session token for subsequent requests.
Include the provider token as a Bearer token in the Authorization header.
Request
Provide a valid provider JWT as a Bearer token in the Authorization header.
curl -X GET https://api.casaphq.com/v1/authenticate \
-H "Authorization: Bearer <provider_jwt>"
JWT issuer URL identifying the token provider
Subject identifier (member's unique ID)
Numeric member ID from the core banking system
accountsId
This is some text inside of a div block.
string[]
This is some text inside of a div block.
Required
This is some text inside of a div block.
List of account IDs the member has access to
This is some text inside of a div block.
orgId
This is some text inside of a div block.
string
This is some text inside of a div block.
Required
This is some text inside of a div block.
Organization UUID identifying the credit union
This is some text inside of a div block.
name
This is some text inside of a div block.
string
This is some text inside of a div block.
Optional
This is some text inside of a div block.
Member's full name
This is some text inside of a div block.
locale
This is some text inside of a div block.
string
This is some text inside of a div block.
Optional
This is some text inside of a div block.
Language locale (e.g. en)
This is some text inside of a div block.
Response
JWT session token for authenticating API requests
Token expiration time (Unix milliseconds)
Example Response
{
"session_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expires_at": 1708387200000
}
Create Dispute
Submit a new dispute with the disputed transaction details and customer information.
Request Body
Dispute reason enum value
List of disputed transactions
Survey question responses
Response
The newly created dispute object
Example
{
"org_uuid": "16131e64-90ad-484d-8b65-29f2725299a2",
"customer": {
"name": "Jane Smith",
"member_id": "98765"
},
"reason": "DISPUTE_REASON_UNAUTH",
"transaction_details": [
{
"uuid": "txn-uuid-here",
"amount": { "value": 5000, "currency": "USD" }
}
]
}
Response
Get Disputes
Retrieve a paginated list of disputes. Supports filtering by customer UUID or short ID.
Query Parameters
int32
Optional
Number of results per page (default 20)
int32
Optional
Page number (1-indexed, default 1)
string
Optional
Filter disputes by customer UUID
string
Optional
Filter by dispute short ID
Response
DisputeSummary[]
Optional
Paginated list of disputes
int32
Optional
Total number of disputes matching the query
int32
Optional
Current page number (1-indexed)
Example
{
"items": {
"org_uuid": "16131e64-90ad-484d-8b65-29f2725299a2",
"customer": {
"name": "Jane Smith",
"member_id": "98765"
},
"reason": "DISPUTE_REASON_UNAUTH",
"transaction_details": [
{
"uuid": "txn-uuid-here",
"amount": { "value": 5000, "currency": "USD" }
}
]
},
"total_items": 1,
"total_pages": 1,
"current_page": 1
}
Query Parameters
Response
Example
Get Dispute Status
Get the current status and full details of a specific dispute by its UUID.
/v1/dispute/status/{dispute_uuid}
Path Parameters
Path Parameters
Path Parameters
Path Parameters
The UUID of the dispute to retrieve
Response
Full dispute summary object
Example
{
"dispute": {
"uuid": "d1a2b3c4-e5f6-7890-abcd-ef1234567890",
"short_id": "CSP-1234",
"status": "DISPUTE_STATUS_OPEN",
"reason": "DISPUTE_REASON_UNAUTH",
"resolution_deadline": 1708300800,
"customer": {
"uuid": "c1a2b3c4-e5f6-7890-abcd-ef1234567890",
"name": "Jane Doe",
"email": "jane.doe@example.com"
},
"agent": null,
"transactions": [
{
"uuid": "t1a2b3c4-e5f6-7890-abcd-ef1234567890",
"settled_timestamp": 1708214400,
"amount": {
"value": 5000,
"currency": "USD"
},
"merchant": "AMAZON.COM",
"status": "DISPUTED_TRANSACTION_STATUS_OPEN",
"transaction_status": "TRANSACTION_STATUS_SETTLED"
}
],
"audit_log": []
}
}
Upload File
Upload a file attachment to an existing dispute.
/v1/disputes/{dispute_uuid}/files
Request Body
The UUID of the dispute (path parameter)
The file content as raw bytes
Example
Example
Example
Reopen Dispute
Reopen a previously closed dispute to add or review additional transactions.
This is some text inside of a div block.
/v1/disputes/{dispute_uuid}/reopen
Request Body
The UUID of the dispute (path parameter)
List of transaction UUIDs to reopen
Response
The reopened dispute summary
Example
{
"dispute": {
"uuid": "d1a2b3c4-e5f6-7890-abcd-ef1234567890",
"short_id": "CSP-1234",
"status": "DISPUTE_STATUS_OPEN",
"reason": "DISPUTE_REASON_UNAUTH",
"resolution_deadline": 1708300800,
"customer": { "..." },
"transactions": [ "..." ],
"audit_log": [ "..." ]
}
}
Request Body
Response
Example
Request Body
Response
Example
Upload File
Type Definitions
This is some text inside of a div block.
DisputeSummary
string
Human-readable dispute ID
This is some text inside of a div block.
string
This is some text inside of a div block.
This is some text inside of a div block.
string
This is some text inside of a div block.
This is some text inside of a div block.
DisputeStatus
This is some text inside of a div block.
Customer
Customer who filed dispute
int64
Resolution deadline (Unix ms)
Agent
Agent acting on the dispute
This is some text inside of a div block.
DisputeReason
This is some text inside of a div block.
This is some text inside of a div block.
Customer
This is some text inside of a div block.
This is some text inside of a div block.
int64
This is some text inside of a div block.
This is some text inside of a div block.
Agent
This is some text inside of a div block.
DisputedTransaction[]
List of disputed transactions
DisputeAuditLog[]
Audit log of dispute events
DisputedTransaction
string
Disputed transaction identifier
This is some text inside of a div block.
string
This is some text inside of a div block.
int64
Settlement time (Unix ms)
DisputedTransactionStatus
OPEN, INVESTIGATING, CHARGEBACK, or CLOSED
provisional_credit_amount
Amount
Provisional credit amount
Amount
int32
Amount in cents (e.g. 10000 = $100.00)
This is some text inside of a div block.
int32
This is some text inside of a div block.
This is some text inside of a div block.
int32
This is some text inside of a div block.
This is some text inside of a div block.
int32
This is some text inside of a div block.
Customer
This is some text inside of a div block.
string
This is some text inside of a div block.
This is some text inside of a div block.
string
This is some text inside of a div block.
TransactionDetail
int64
Settlement time (Unix ms)
int64
Authorization time (Unix ms)
DEBIT_CARD, CREDIT_CARD, ATM, ACH, or TRANSFER
VISA, MASTERCARD, or AMEX
Acquirer Reference Number
Visa-assigned transaction ID
Interbank Card Association number