Skip to main content
DELETE
/
api
/
partner
/
v2
/
receivers
/
{receiverId}
cURL
curl --request DELETE \
  --url https://staging-api.capa.fi/api/partner/v2/receivers/{receiverId} \
  --header 'Content-Type: application/json' \
  --header 'partner-api-key: <partner-api-key>' \
  --data '
{
  "userId": "550e8400-e29b-41d4-a716-446655440000"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "disabled": true
  }
}
Disables (soft-deletes) a receiver. The receiver will no longer be available for new transactions, but existing transactions are not affected.

​
Error Codes

​
Common Errors

HTTP StatusCodeMessage
401UNAUTHORIZED”API Key is missing”
401UNAUTHORIZED”Invalid API Key format”
401UNAUTHORIZED”Invalid API Key”
403INVALID_PARTNER_FLOW”The partner has an invalid flow.”

​
User Ownership Errors

HTTP StatusCodeMessage
401UNAUTHORIZED”Partner information is required for this operation”
401UNAUTHORIZED”User is not associated with the partner”

​
Endpoint-Specific Errors

HTTP StatusCodeMessage
403RECEIVER_ACCESS_FORBIDDEN”You do not have permission to delete this receiver.”
500RECEIVER_DELETION_FAILED”Failed to delete receiver. Please try again later.”

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Path Parameters

​
receiverId
string
required

Receiver ID

Query Parameters

​
userId
string
required

User ID who owns this receiver (for authorization)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
​
userId
string
required

User ID who owns this receiver (for authorization)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

200 - application/json
​
success
boolean
Example:

true

​
data
object