- Keep identity and address data on the recipient.
- Pick a payment rail through a compatible destination.
- Send an information request when the recipient should supply its own payment or tax details.
Recipients
A recipient’srecipientType is contact for a person (shown as “Person” in
the Slash dashboard) or vendor for a business. Archive one with
POST /v2/recipients/{recipientId}/archive;
archiving also hides its destinations from default list results.
A recipient id names who you pay, not where the money goes, so transfers take
a destinationId.
Destinations
Each destination belongs to one recipient. Create one withPOST /v2/destinations, and filter
GET /v2/destinations by recipientId to
list a recipient’s. There are two types:
bank_accountfor ACH, domestic wire, or realtime paymentsinternational_wirefor international wires
supportedTransferTypes rather than inferring
compatibility from type, and only send to it while its status allows the
rail.
Archive a destination without affecting its recipient with
POST /v2/destinations/{destinationId}/archive.
Both list endpoints omit archived resources unless includeArchived=true.
Information requests
POST /v2/information-requests
emails the recipient a secure form asking for any combination of destination,
address, and tax details. A recipient can have one pending request at a
time.
What the recipient submits is stored on the recipient, not on the request:
- destinations appear in
GET /v2/destinations - the address replaces the recipient’s
address - tax details are returned by
GET /v2/recipients/{recipientId}/tax-details
submitted means the recipient has submitted the form at least once and can
keep editing it. Only a pending request can be canceled.
An information request can ask for
crypto_address, but crypto destinations
are not returned as destinations and cannot be used to create a transfer.not_found, the same as an id that doesn’t exist.