curl --request POST \
--url https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment \
--header 'Authorization: Bearer <token>'import requests
url = "https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment', 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://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"amountInCents": 123,
"createdAt": 123,
"vendorDeliveryMethodId": "<string>",
"vendorPayoutMethodId": "<string>",
"billPayableId": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Stop payment on a check bill payment
Stops payment on a check bill payment that has already been issued but not yet deposited. Pre-mail checks are cancelled and mailed checks are stopped through the bank; either way the merchant is automatically refunded and the bill is returned to unpaid. A check that has already been deposited can no longer be stopped. Use the cancel endpoint for a bill payment whose check has not been issued yet.
curl --request POST \
--url https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment \
--header 'Authorization: Bearer <token>'import requests
url = "https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment', 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://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.staging.nickel.com/billPayment/{billPaymentId}/stopPayment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"status": "<string>",
"amountInCents": 123,
"createdAt": 123,
"vendorDeliveryMethodId": "<string>",
"vendorPayoutMethodId": "<string>",
"billPayableId": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the check bill payment to stop
Response
Successful operation
ID of the vendor delivery method the funds were sent to.
Deprecated alias of vendorDeliveryMethodId, retained for backwards compatibility.
Opaque ID grouping the payment attempts made against one bill. Not directly retrievable through the API; use the bill and bill payment endpoints instead.
