Simulate inbound return request
API reference
Simulate receiving a request to return funds from the receiving bank after payment settlement
This API can only be run in the Cross River Sandbox
curl -X POST https://sandbox.crbcos.com/rtp/v1/payments/{id}/simulated-inbound-return-request \\
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \\
-H "Content-Type: application/json" \\
-d '{
"additionalInfo": "sample_value",
"caseCreatorName": "John Doe",
"originatorOrgAnyBIC": "CHASUS33XXX",
"originatorOrgLEI": "sample_value",
"originatorOrgOtherId": "sample_value"
}'Use cases
- Test payment return handling in sandbox environment
- Validate return reason code processing
- Develop return dispute workflows without affecting real payments
- Train staff on various return scenarios (fraud, closed account, incorrect account)
Error codes
Code | Scenario | Resolution |
|---|---|---|
2021 | Only Credit Transfers can be refunded | Verify request parameters and retry |
2015 | Payment had already been refunded | Verify request parameters and retry |
2019 | Return can not be requested for a Credit Transfer due to payment status | Verify request parameters and retry |
2028 | Simulator-Credit Transfer must be inbound | Verify request parameters and retry |
2022 | Payment already has an existing return of funds in process | Verify request parameters and retry |
2039 | ReasonCode is missing or invalid | Verify request parameters and retry |
2063 | Reason code UAPA only available for RTP v5.0. Please use reason code FRAD. | Verify request parameters and retry |
2042 | AdditionalInfo is required for specified ReasonCode | Verify request parameters and retry |
2066 | Case creator name can only be used for FedNow payments. | 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