Overview
This endpoint manages payees for a user.
Payee Object
The ampliFi API represents payees by a JSON object. This table lists properties that are usually included in a payee object.
Property to Modify | Description | Schema | Example Values |
---|---|---|---|
name | Name for the beneficiary | string | "testPayee1" |
defaultAmount | Default transfer amount, if any | number | 20.00 |
defaultCurrency | 3-letter currency designator for default amount | string | "USD" |
status | Current beneficiary status | string | "Active" |
isActive | true if active | boolean | true or false |
isFavourite | true if favorited | boolean | true or false |
paypalId | The PayPal ID, for PayPal transfers | string | "paypal@email.test" |
bankName | Name of the destination bank, for USA ACH and wire transfers | string | "Citi" |
accountNumber | Destination account number, for USA ACH and wire transfers | string | "1234567890123456" |
routingNumber | Destination routing number, for USA ACH and wire transfers | string | "123456789" |
destinationName | Last name on the destination account, for transfer to card | string | "John Doe" |
type | Type of account, if applicable | string | "CHECKING" |
destinationFirstName | First name on the destination account, for transfer to card | string | "John" |
destinationLastName | Last name on the destination account, for transfer to card | string | "Doe" |
destinationPAN | PAN, for transfer to card | string | "1234567890123456" |
expiryYYYYMM | Expiration date, for transfer to card | string | "202905" |