Decline a payment request
curl --request POST \
--url https://api.plane.com/v1/payment-requests/{id}/decline \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"approver": "<string>",
"reason": "<string>"
}
'import requests
url = "https://api.plane.com/v1/payment-requests/{id}/decline"
payload = {
"approver": "<string>",
"reason": "<string>"
}
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({approver: '<string>', reason: '<string>'})
};
fetch('https://api.plane.com/v1/payment-requests/{id}/decline', 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.plane.com/v1/payment-requests/{id}/decline",
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([
'approver' => '<string>',
'reason' => '<string>'
]),
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.plane.com/v1/payment-requests/{id}/decline"
payload := strings.NewReader("{\n \"approver\": \"<string>\",\n \"reason\": \"<string>\"\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://api.plane.com/v1/payment-requests/{id}/decline")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"approver\": \"<string>\",\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/payment-requests/{id}/decline")
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 \"approver\": \"<string>\",\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"status": "declined",
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
},
"documents": [],
"approvals": ["appr_YzmQ5oxQE78bDV3fZwEU3vGr"],
"payment": null
}
Payment Requests
Decline a payment request
POST
/
v1
/
payment-requests
/
{id}
/
decline
Decline a payment request
curl --request POST \
--url https://api.plane.com/v1/payment-requests/{id}/decline \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"approver": "<string>",
"reason": "<string>"
}
'import requests
url = "https://api.plane.com/v1/payment-requests/{id}/decline"
payload = {
"approver": "<string>",
"reason": "<string>"
}
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({approver: '<string>', reason: '<string>'})
};
fetch('https://api.plane.com/v1/payment-requests/{id}/decline', 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.plane.com/v1/payment-requests/{id}/decline",
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([
'approver' => '<string>',
'reason' => '<string>'
]),
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.plane.com/v1/payment-requests/{id}/decline"
payload := strings.NewReader("{\n \"approver\": \"<string>\",\n \"reason\": \"<string>\"\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://api.plane.com/v1/payment-requests/{id}/decline")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"approver\": \"<string>\",\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/payment-requests/{id}/decline")
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 \"approver\": \"<string>\",\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"status": "declined",
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
},
"documents": [],
"approvals": ["appr_YzmQ5oxQE78bDV3fZwEU3vGr"],
"payment": null
}
Declines a payment request and sends it back to the worker.
Parameters
The ID of the payment request you are declining.
The UUID of the manager declining this request.
A description of why the request was declined, visible to the worker.
Returns
Returns the Payment Request object with a declined status.{
"id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"status": "declined",
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
},
"documents": [],
"approvals": ["appr_YzmQ5oxQE78bDV3fZwEU3vGr"],
"payment": null
}
Was this page helpful?
⌘I