Skip to main content
GET
/
api
/
partner
/
v2
/
transactions
/
mock-testing-guide
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/transactions/mock-testing-guide \
  --header 'partner-api-key: <partner-api-key>'
{
  "success": true,
  "data": {}
}
Returns the current mock testing configuration for the staging environment. Use specific transaction amounts to simulate different outcomes.
Mock testing is only available in the staging environment.

​
Mock Rules

​
On-Ramp Transactions

Use fiatAmount to trigger specific behaviors:
Fiat AmountExpected StatusDescription
10.01COMPLETEDTransaction completes successfully
10.02CANCELLED (NAME_VERIFICATION_FAILED)Bank beneficiary is not the KYC’d user

​
Off-Ramp Transactions

Use cryptoAmount to trigger specific behaviors:
Crypto AmountExpected StatusDescription
10.01COMPLETEDTransaction completes successfully
10.02CANCELLED (NAME_VERIFICATION_FAILED)Bank beneficiary is not a KYC’d user
10.03CRYPTO_NOT_RECEIVEDFailure due to no crypto transfer

​
Important Notes

  • You must use the exact amounts specified above (10.01, 10.02, 10.03).
  • All other validation rules still apply (KYC status, limits, etc.).
  • The system automatically handles state transitions to reach the target status.

​
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.”

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Response

200 - application/json

This endpoint provides documentation for partners on how to trigger different transaction statuses using specific amounts.

Only available in testing environments.

​
success
boolean
Example:

true

​
data
object