Simulate inbound payment request cancel
API reference
Simulate receiving a cancellation message for a previously sent request for payment
This API can only be run in the Cross River Sandbox
Endpoint: /rtp/payments/{id}/simulated-inbound-payment-request-cancel
POST
https://sandbox.crbcos.com/rtp/v1/payments/{id}/simulated-inbound-payment-request-cancel
curl -X POST https://sandbox.crbcos.com/rtp/v1/payments/{id}/simulated-inbound-payment-request-cancel \\
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \\
-H "Content-Type: application/json" \\
-d '{
"reasonCode": "sample_value"
}'Use cases
- Test RFP cancellation handling in sandbox
- Validate cancellation reason code processing
- Develop pre-authorization cancellation workflows
- Train staff on RFP lifecycle management
Error codes
Code | Scenario | Resolution |
|---|---|---|
2018 | Invalid Debtor | Verify request parameters and retry |
2017 | Payments of $3,000 or more require a complete debtor address | Verify request parameters and retry |
2007 | Direction not inbound | Verify request parameters and retry |
3001 | Unauthorized | Verify Bearer token is valid and not expired |
3002 | Insufficient permissions | Verify user has required permission for this operation |
Business rules
- Requires valid Bearer token with permissions: Permissions.Payments.Simulate
- Request validation performed before processing
- Errors return 400 Bad Request with detailed error information
- Rate limiting may apply to prevent abuse