Use this API to initiate a transfer using an existing recipient by providing the recipientId. you do not need to provide all the recipient's account and address details—these will be retrieved using the recipientId. To understand more about the individual payment rails. We can do these payments :
- INTERNAL
- ACH
- SAMEDAYACH
- External Card Pull
- External Card Push
- WIRE
- International WIRE (SWIFT)
During the lifecycle of a transfer, its status may undergo changes. Refer to the Transfer Status page at Transfer Status for detailed descriptions associated with each status.
For Payment Rails such as Domestic and Internal WIRE, the recipient address is mandatory. To pass the recipient address, one needs to pass the stateCode, countryCode. This information can be viewed at US State Codes
Please check the below BODY PARAMS section for different types of Transfers.
**Note1: All the payment API's have the endpoint: /payments **
**Note2: The recipient's client must belong to the same originator account as the payment. If the recipient's client is not associated with the originator account, the system will return an error: 'Payment cannot be processed because the recipient ID does not belong to the originator account **
| Function | Webhook |
|---|---|
| Create Transfer | Create Transfer |
| Submit Transfer | Submit Transfer |
| Force Submit Transfer | Force Submit Transfer |
| Create and Submit Transfer | Create and Submit Transfer |