SLslashfi

Request recipient details

Changed on

Email an existing recipient a secure form asking for any combination of payment destination details, an address, and tax details. Submitted destinations appear in GET /v2/destinations, the address replaces the recipient's address, and tax details are returned by GET /v2/recipients/{recipientId}/tax-details. A recipient can have at most one pending information request. Use an information request that accepts bank_account to create queued ACH, realtime or wire transfers while awaiting the recipient's bank details.

post/v2/information-requests

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/information-requests
  • Auth
    API key in header X-API-Key

Headers

X-Idempotency-Keystring required

Unique caller-generated key for one create request. Once an authenticated, schema-valid request reaches the operation, the key is permanently consumed for that operation and legal entity whether the operation succeeds or fails. Reusing it in that scope returns 409 and never replays a response, unlike API v1, which replays the original response for a matching key.

Request body

recipientIdstring required

The recipient to ask.

requesterNamestring required

Name shown to the recipient in the request email and secure form.

ccEmailsstring[]
notestring

Optional message shown to the recipient.

Example request

{
  "recipientId": "le_c_vendor123",
  "requestedInformation": {
    "destinationTypes": [
      "bank_account"
    ],
    "tax": true
  },
  "requesterName": "Northwind Operations"
}

Response

Information request created and sent.

idstring required

Information request id.

recipientIdstring required

The recipient that received the request.

status'pending' | 'submitted' | 'canceled' required

Current recipient response state.

sentToEmailstring email required

Email address to which Slash sent the request.

ccEmailsstring[] required
requesterNamestring required

Name shown to the recipient in the request email and secure form.

notestring
sentAtstring date-time required
firstSubmittedAtstring date-time
lastSubmittedAtstring date-time
canceledAtstring date-time
createdAtstring date-time required

Changes