curl --request PUT \
--url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"reason": "<string>",
"currencyCode": "USD"
}
'import requests
url = "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override"
payload = {
"amount": 123,
"reason": "<string>",
"currencyCode": "USD"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: 123, reason: '<string>', currencyCode: 'USD'})
};
fetch('https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override', 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://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 123,
'reason' => '<string>',
'currencyCode' => 'USD'
]),
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://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override"
payload := strings.NewReader("{\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"currencyCode\": \"USD\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"currencyCode\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"currencyCode\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"accountOverride": {
"currencyCode": "<string>",
"value": 123
},
"bankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"errorCode": "<string>",
"detail": "<string>",
"errors": {},
"instance": "<string>",
"questionErrors": [
{
"code": "REQUIRED",
"message": "<string>",
"itemPath": "<string>",
"key": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"requirementsVersion": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"errorCode": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Set account override
Gives one bank account its own daily limit in place of its default, above or below it, from its next payment; zero stops Instant Payments. The bank account must be at the caller’s Bank. Each change is recorded in the limit-change history.
Token types: USER | Required scopes: instant_payment_limit:write:org
curl --request PUT \
--url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"reason": "<string>",
"currencyCode": "USD"
}
'import requests
url = "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override"
payload = {
"amount": 123,
"reason": "<string>",
"currencyCode": "USD"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: 123, reason: '<string>', currencyCode: 'USD'})
};
fetch('https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override', 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://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 123,
'reason' => '<string>',
'currencyCode' => 'USD'
]),
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://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override"
payload := strings.NewReader("{\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"currencyCode\": \"USD\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"currencyCode\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id}/instant-payment-limit/override")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"reason\": \"<string>\",\n \"currencyCode\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"accountOverride": {
"currencyCode": "<string>",
"value": 123
},
"bankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"errorCode": "<string>",
"detail": "<string>",
"errors": {},
"instance": "<string>",
"questionErrors": [
{
"code": "REQUIRED",
"message": "<string>",
"itemPath": "<string>",
"key": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"requirementsVersion": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"errorCode": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Authorizations
User OAuth2 access token (authorization code with PKCE).
Path Parameters
The bank account ID.
Body
Request model for setting a daily Instant Payment limit, shared by RTP and FedNow.
The daily limit in the currency's minor units (e.g. cents for USD). Zero stops Instant Payments; it must not be negative.
Why the limit is changing, recorded in the limit-change history. A ticket reference is enough.
ISO 4217 alphabetic currency code. Only USD is accepted. Defaults to USD when omitted.
Was this page helpful?