curl --request POST \
--url https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Invoices EU",
"idempotencyKey": "7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37"
}
'import requests
url = "https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions"
payload = {
"name": "Invoices EU",
"idempotencyKey": "7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Invoices EU', idempotencyKey: '7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37'})
};
fetch('https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Invoices EU',
'idempotencyKey' => '7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions"
payload := strings.NewReader("{\n \"name\": \"Invoices EU\",\n \"idempotencyKey\": \"7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.post("https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Invoices EU\",\n \"idempotencyKey\": \"7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Invoices EU\",\n \"idempotencyKey\": \"7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37\"\n}"
response = http.request(request)
puts response.read_body{
"accountId": "acc_01JMERUSDTRSY01",
"name": "Invoices EU",
"status": "PENDING",
"idempotencyKey": "7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}Add a Deposit Instruction to an Account
Starts provisioning a new, named deposit instruction on an existing account. Funds received on it are swept into the account automatically. Responds 202 Accepted; the instruction appears in GET /v1/accounts/{accountId} once provisioned. A retry that reuses the same idempotencyKey with a different name does not rename the instruction: the name from the first request wins. For stablecoin accounts, the new address also appears on your other stablecoin accounts for the assets and networks it supports.
curl --request POST \
--url https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Invoices EU",
"idempotencyKey": "7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37"
}
'import requests
url = "https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions"
payload = {
"name": "Invoices EU",
"idempotencyKey": "7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Invoices EU', idempotencyKey: '7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37'})
};
fetch('https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Invoices EU',
'idempotencyKey' => '7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions"
payload := strings.NewReader("{\n \"name\": \"Invoices EU\",\n \"idempotencyKey\": \"7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.post("https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Invoices EU\",\n \"idempotencyKey\": \"7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.va.meridianpay.com/v1/accounts/{accountId}/deposit-instructions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Invoices EU\",\n \"idempotencyKey\": \"7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37\"\n}"
response = http.request(request)
puts response.read_body{
"accountId": "acc_01JMERUSDTRSY01",
"name": "Invoices EU",
"status": "PENDING",
"idempotencyKey": "7f3c2a9e-5b1d-4e8a-9c6f-2d4b8a1e0c37"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}{
"message": "<string>",
"validationErrors": [
{
"fieldRef": "<string>",
"type": "InvalidFormat",
"message": "<string>"
}
],
"errorCode": "UNAUTHORIZED"
}Authorizations
Bearer token authentication, for client-server calls.
Send the access token issued by POST /v1/auth/token as Authorization: Bearer {token}. The token carries its own program and user context, so the X-Meridian-* headers are not required. See Authentication.
Headers
Server-to-server (HMAC) requests only. Partner API key issued by Meridian during provisioning.
Server-to-server (HMAC) requests only. Current time in milliseconds since the Unix epoch. Must be within 60 seconds of the request.
Server-to-server (HMAC) requests only. Identifies the program context for the request.
Server-to-server (HMAC) requests only. Identifies the Meridian user targeted by the request. Required for MULTI_USER integrations; omit for SINGLE_USER.
Path Parameters
ID of the account — the id returned by GET /v1/accounts.
Body
Name and idempotency key for the new deposit instruction
Request payload for adding a deposit instruction to an account
Display name for the new deposit instruction. 1-64 characters; need not be unique.
"Invoices EU"
Client-supplied idempotency key; retries with the same key are de-duplicated. If a retry reuses the key with a different name, the name from the first request wins.
"a1b2c3d4"
Response
Provisioning started
Accepted request to add a deposit instruction; it appears on the account once provisioned
The account the deposit instruction is being added to
Display name of the new deposit instruction
Always PENDING; poll GET /v1/accounts/{accountId} for the new instruction
"PENDING"
The idempotency key supplied on the request