Skip to main content
A Contact is a person or business your legal entity may pay. A Destination is one set of payment instructions owned by that Contact.
Keep the resources separate:
  • Update recipient identity and address data through the Contact.
  • Select a payment rail through a compatible Destination.
  • Use an Information Request when the Contact should securely supply its own payment or compliance information.

​
Contacts

Contacts have a recipientType of contact or vendor. Archive one with POST /v2/contacts/{contactId}/archive. Archiving is represented by status: archived and also hides the Contact’s Destinations from default list results. The Contact id identifies the recipient, not a payable bank account. Transfer creation therefore accepts destinationId, not contactId.

​
Destinations

The API exposes two saved Destination types:
  • bank_account for compatible ACH, domestic wire, or realtime payments
  • international_wire for international wires
Use supportedTransferTypes from the Destination response instead of inferring compatibility from type alone. A Destination may be active, pending, disabled, or archived; only use it when its current status and supported transfer types permit the intended rail. GET /v2/destinations is a top-level collection. Filter by contactId to list the payment instructions owned by one Contact. Archive one Destination without affecting its Contact with POST /v2/destinations/{destinationId}/archive. Both list endpoints omit archived resources by default; set includeArchived=true to include them.

​
Information requests

POST /v2/information-requests emails an existing Contact a secure form. The request can ask for one or more of:
  • destination details
  • address details
  • tax details
Only one request may be pending for a Contact at a time. List requests with GET /v2/information-requests, optionally filtering by contactId or status. Statuses mean:
  • pending — the recipient has not submitted the form
  • submitted — the recipient submitted at least once and may continue editing through the secure form
  • canceled — the request is no longer active
Only a pending request can be canceled through the public API.
An Information Request can ask for crypto_address, but crypto destinations are not returned by the Destination collection and cannot be used to create a transfer.