Request payment details

POST

information-requests

curl --request POST \
  --url https://api.slash.com/v2/information-requests \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --header 'x-legal-entity: <x-legal-entity>' \
  --data '
{
  "contactId": "<string>",
  "requestedInformation": {
    "destinationTypes": [],
    "address": true,
    "tax": true
  },
  "requesterName": "<string>",
  "ccEmails": [
    "jsmith@example.com"
  ],
  "note": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    'x-legal-entity': '<x-legal-entity>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactId: '<string>',
    requestedInformation: {destinationTypes: [], address: true, tax: true},
    requesterName: '<string>',
    ccEmails: ['jsmith@example.com'],
    note: '<string>'
  })
};

fetch('https://api.slash.com/v2/information-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/information-requests"

payload = {
    "contactId": "<string>",
    "requestedInformation": {
        "destinationTypes": [],
        "address": True,
        "tax": True
    },
    "requesterName": "<string>",
    "ccEmails": ["jsmith@example.com"],
    "note": "<string>"
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/information-requests"

	payload := strings.NewReader("{\n  \"contactId\": \"<string>\",\n  \"requestedInformation\": {\n    \"destinationTypes\": [],\n    \"address\": true,\n    \"tax\": true\n  },\n  \"requesterName\": \"<string>\",\n  \"ccEmails\": [\n    \"jsmith@example.com\"\n  ],\n  \"note\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "contactId": "<string>",
  "status": "pending",
  "requestedInformation": {
    "destinationTypes": [
      "bank_account"
    ],
    "address": true,
    "tax": true
  },
  "sentToEmail": "jsmith@example.com",
  "ccEmails": [
    "jsmith@example.com"
  ],
  "requesterName": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "firstSubmittedAt": "2023-11-07T05:31:56Z",
  "lastSubmittedAt": "2023-11-07T05:31:56Z",
  "canceledAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

X-Idempotency-Key

string

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.

Required string length: 1 - 255

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Body

application/json

Ask an existing contact to securely provide payment or compliance details. Crypto addresses collected through this flow are not exposed by the API v2 Destination collection.

contactId

string

required

Contact id with the le_c_ prefix.

requestedInformation

object

required

Information the contact may provide through the secure form.

Hide child attributes

requestedInformation.destinationTypes

enum<string>[]

Minimum array length: 1

Available options:

bank_account,

international_wire,

crypto_address

requestedInformation.address

enum<boolean>

Available options:

true

requestedInformation.tax

enum<boolean>

Available options:

true

requesterName

string

required

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

Minimum string length: 1

ccEmails

string<email>[]

note

string

Optional message shown to the contact.

Response

Information request created and sent.

A request asking a contact to securely provide payment or compliance details. A requested crypto address is collected through the recipient flow but is not exposed by the API v2 Destination collection.

string

required

Information request id with the le_c_info_req_ prefix.

contactId

string

required

Contact that received the request.

status

enum<string>

required

Current recipient response state.

Available options:

pending,

submitted,

canceled

requestedInformation

object

required

Information the contact may provide through the secure form.

Hide child attributes

requestedInformation.destinationTypes

enum<string>[]

Minimum array length: 1

Available options:

bank_account,

international_wire,

crypto_address

requestedInformation.address

enum<boolean>

Available options:

true

requestedInformation.tax

enum<boolean>

Available options:

true

sentToEmail

string<email>

required

Email address to which Slash sent the request.

ccEmails

string<email>[]

required

requesterName

string

required

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

sentAt

string<date-time>

required

createdAt

string<date-time>

required

note

string

firstSubmittedAt

string<date-time>

lastSubmittedAt

string<date-time>

canceledAt

string<date-time>

⌘I

Request payment details

curl --request POST \
  --url https://api.slash.com/v2/information-requests \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Idempotency-Key: <x-idempotency-key>' \
  --header 'x-legal-entity: <x-legal-entity>' \
  --data '
{
  "contactId": "<string>",
  "requestedInformation": {
    "destinationTypes": [],
    "address": true,
    "tax": true
  },
  "requesterName": "<string>",
  "ccEmails": [
    "jsmith@example.com"
  ],
  "note": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency-Key': '<x-idempotency-key>',
    'x-legal-entity': '<x-legal-entity>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactId: '<string>',
    requestedInformation: {destinationTypes: [], address: true, tax: true},
    requesterName: '<string>',
    ccEmails: ['jsmith@example.com'],
    note: '<string>'
  })
};

fetch('https://api.slash.com/v2/information-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/information-requests"

payload = {
    "contactId": "<string>",
    "requestedInformation": {
        "destinationTypes": [],
        "address": True,
        "tax": True
    },
    "requesterName": "<string>",
    "ccEmails": ["jsmith@example.com"],
    "note": "<string>"
}
headers = {
    "X-Idempotency-Key": "<x-idempotency-key>",
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/information-requests"

	payload := strings.NewReader("{\n  \"contactId\": \"<string>\",\n  \"requestedInformation\": {\n    \"destinationTypes\": [],\n    \"address\": true,\n    \"tax\": true\n  },\n  \"requesterName\": \"<string>\",\n  \"ccEmails\": [\n    \"jsmith@example.com\"\n  ],\n  \"note\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "contactId": "<string>",
  "status": "pending",
  "requestedInformation": {
    "destinationTypes": [
      "bank_account"
    ],
    "address": true,
    "tax": true
  },
  "sentToEmail": "jsmith@example.com",
  "ccEmails": [
    "jsmith@example.com"
  ],
  "requesterName": "<string>",
  "sentAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "note": "<string>",
  "firstSubmittedAt": "2023-11-07T05:31:56Z",
  "lastSubmittedAt": "2023-11-07T05:31:56Z",
  "canceledAt": "2023-11-07T05:31:56Z"
}

Accounts

Virtual accounts

Contacts

Transfers

Transactions

Request payment details

Authorizations

Headers

Body

Response