Get an invoice's payment instructions - Slash

GET

/

v2

/

invoices

/

{invoiceId}

/

payment-instructions

Get an invoice's payment instructions

curl --request GET \
  --url https://api.slash.com/v2/invoices/{invoiceId}/payment-instructions \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'GET',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/invoices/{invoiceId}/payment-instructions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/invoices/{invoiceId}/payment-instructions"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.slash.com/v2/invoices/{invoiceId}/payment-instructions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "bankTransfer": {
    "beneficiaryName": "<string>",
    "bankName": "<string>",
    "beneficiaryAddress": "<string>",
    "bankAddress": "<string>",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "swift": "<string>",
    "reference": "<string>"
  },
  "crypto": [
    {
      "currency": "USDC",
      "network": "ethereum",
      "address": "<string>",
      "memo": "<string>"
    }
  ]
}

See Payment instructions.

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-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]+$

Path Parameters

invoiceId

string

required

Invoice id with the inv_ prefix.

Response

The invoice's payment instructions.

How a payer can pay the invoice outside the payment page.

bankTransfer

object

required

The bank details printed on the invoice. Payments sent with reference are matched to the invoice automatically.

Hide child attributes

bankTransfer.beneficiaryName

string

required

bankTransfer.bankName

string

required

bankTransfer.beneficiaryAddress

string

bankTransfer.bankAddress

string

bankTransfer.accountNumber

string

bankTransfer.routingNumber

string

ABA routing number for ACH, wire and realtime payments.

bankTransfer.swift

string

SWIFT code for international wires.

bankTransfer.reference

string

What the payer should put in the payment's memo.

crypto

object[]

required

Deposit addresses, when the invoice takes crypto.

Hide child attributes

crypto.currency

string

required

Example:

"USDC"

crypto.network

string

required

Example:

"ethereum"

crypto.address

string

required

crypto.memo

string

Include with the deposit on networks that need one.

⌘I

Get an invoice's payment instructions

curl --request GET \
  --url https://api.slash.com/v2/invoices/{invoiceId}/payment-instructions \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'GET',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/invoices/{invoiceId}/payment-instructions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/invoices/{invoiceId}/payment-instructions"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.slash.com/v2/invoices/{invoiceId}/payment-instructions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "bankTransfer": {
    "beneficiaryName": "<string>",
    "bankName": "<string>",
    "beneficiaryAddress": "<string>",
    "bankAddress": "<string>",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "swift": "<string>",
    "reference": "<string>"
  },
  "crypto": [
    {
      "currency": "USDC",
      "network": "ethereum",
      "address": "<string>",
      "memo": "<string>"
    }
  ]
}