Payment RFIs - Collections

Workflow

Step	Description	Request
1	RFI Requested	If Rail requires more information on a Payment it will request a document to be uploaded to the Payment.
2	RFI Notification (Webhook)	Client can subscribe to the `PAYMENT_CHANGES_REQUESTED` webhook event to receive realtime notifcations when an RFI occurs. This webhook contains the Payment id the RFI is related to.
3	Understanding RFI Requirement (Retrieve Withdrawal Status)	Provide information related the relationship between two entities.
4	Repond to RFI (Upload Document to Withdrawal)	Clients can use the Retrive Withdrawal Status endpoint to understand what is required to satisfy the RFI. The response of Retrieve Withdrawal Status will show that the status of the Payment is `CHANGES_REQUESTED`. The response will also list the 'errors' that need to be satisfied before the Payment can continue processing. For Payments, the request will usually require clients to upload a proof of payment (invoice) to the Payment in question. The `document_errors` block of the response will contain a `document_id` for clients to upload the invoice to.
5	Finish Processing the Withdrawal	Once the document is uploaded, and Rail is satisfied with the information provided, the status of the Payment will be updated to `IN_PROGRESS` and the Payment will be processed. Once the Payment is processed the Payment status will change to `EXECUTED`.

Scenarios

Scenario 1 - Payment Lifecycle - Up Front RFI

Scenario where the Rail requires additional information to be provided on the payment.

Action	Payment Status	Webhook Event
Request payment	`REQUESTED`
RFI is required for payment.	`CHANGES_REQUESTED`	`PAYMENT_CHANGES_REQUESTED`
Client uploads document to payment. Payment can now be Accepted.	`REQUESTED`
Accept payment. Deposit instructions are in the response.	`ACCEPTED`
(External) Share payment instructions with counterparty.	`ACCEPTED`
(External) Counterparty makes payment to unique instructions.	`ACCEPTED`
Funds are received into customer account with instructions. AML and processing begin.	`ACCEPTED`
Funds credited to destination account. Total funds < payment amount	`IN_PROGRESS`	`PAYMENT_IN_PROGRESS`
Funds credited to destination account. Toal funds >= payment amount	`EXECUTED`	`PAYMENT_EXECUTED`

Scenario 2 - Payment Lifecycle - Post-Accept RFI

Scenario where the Rail requires additional information to be provided on the payment.

Action	Payment Status	Webhook Event
Request payment.	`REQUESTED`
Accept payment. Deposit instructions are in the response.	`ACCEPTED`
(External) Share payment instructions with counterparty.	`ACCEPTED`
(External) Counterparty makes payment to unique instructions.	`ACCEPTED`
Funds are received into customer account with instructions. AML checks happen.	`IN_PROGRESS`	`PAYMENT_IN_PROGRESS`
RFI is required for payment	`CHANGES_REQUESTED`	`PAYMENT_CHANGES_REQUESTED`
Client uploads all documents. RFI review begins.	`IN_REVIEW`	`PAYMENT_IN_REVIEW`
RFI response is accepted. Payment begins processing.	`IN_PROGRESS`	`PAYMENT_IN_PROGRESS`
Funds credited to destination account. Total funds < payment amount	`IN_PROGRESS`	`PAYMENT_IN_PROGRESS`
Funds credited to destination account. Toal funds >= payment amount	`EXECUTED`	`PAYMENT_EXECUTED`