Return rails

you can manage both deposit and withdrawal checking for your customers using cross river apis returnrail api overview the returnrail api provides partners with a method to return one or more rails that are in success or requested status this api enables partners to programmatically trigger the return operation (revoke/reverse) on a specific rail that was requested on a loan supported rail types xpay (internal transfer) check (only if not yet cashed) flow of funds when this api can be called before calling the returnrail api, ensure the rail is eligible for return rail status should be one of the following success requested checkmailed returning a check actually revokes it from our positive pay system this can only be done before a check is cashed flow of return rails when trying to fund a rail, an id is returned in the response you will need this rail id in order to track this rail id using the railupdated docid\ jxgfrbtnhoshrzjyhykto the full list of fundresults found in this webhook is in the railresulttype docid\ hpq qwoakv9jprqwkfr1i request the returnrails api, using this raiid when the return of a rail completes, the loan status will also be updated, depending on the current status of the loan you can track this with the loanstatusupdated hook notification requesting the returnrails api, will always return a 200 if the request was correct the return is considered completed when you receive the return status in the railupdated webhook event if the return is not completed, you will not receive a notification about this flow of statuses in railupdated webhook action fundresult ( railresulttype docid\ hpq qwoakv9jprqwkfr1i ) description post /returnrails succeeds this api just kicks off the return process the status of the rail does not yet change the return succeeds returned the rail has been successfully reversed, and now the loan amount of the rail will be available to be disbursed again put /{loanid}/ returnrails { "name" "return rails", "method" "put", "url" "https //arixapisandbox crbnj net/loan/{loanid}/returnrails", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "lhsugoegpg4flwk7y 4ou", "language" "curl", "code" "curl location globoff 'https //arixapisandbox crbnj net/loan/{loanid}/returnrails' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\n \\"railids\\" \[\\"\<railid1>\\", \\"\<railid2>\\"],\n \\"reason\\" \\"string\\"\n}'", "customlabel" "" } ], "selectedlanguageid" "lhsugoegpg4flwk7y 4ou" }, "results" { "languages" \[ { "id" "qqhilt fhhpgn7vzgszaq", "language" "200", "code" "{\n \n}", "customlabel" "" }, { "id" "tyfobrzvvk1n0suyh7d l", "language" "400", "code" " {\n \\"responsestatus\\" {\n \\"errorcode\\" \\"badrequest\\",\n \\"message\\" \\"loan was not provided for the provided loanid\\",\n \\"errors\\" \[]\n }\n}\n", "customlabel" "" } ], "selectedlanguageid" "tyfobrzvvk1n0suyh7d l" }, "request" { "pathparameters" \[ { "name" "loanid", "kind" "required", "type" "string", "description" "the unique id of the loan returned from the post /loan api call ", "" "the unique id of the loan returned from the post /loan api call " } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "railids", "kind" "required", "type" "array", "description" "unique identifier of rail that was previously created in arix arix generates this identifier ", "" "unique identifier of rail that was previously created in arix arix generates this identifier " }, { "name" "reason", "kind" "required", "type" "string", "description" "the reason that you are requesting a return ", "" "the reason that you are requesting a return " } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "response" \[ { "name" "message", "kind" "optional", "type" "string", "description" "returns a verbose message that explains the status of the request", "children" \[] } ], "hastryitout" false, "autogeneratedanchorslug" "return rails", "legacyhash" "giyxrerbs0ouftgmvv7 k" }