curl --request POST \
--url https://api.montereyfinancial.app/v1/payments/{payment_id}/reversal \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"reason": "<string>",
"is_nsf": false
}
'import requests
url = "https://api.montereyfinancial.app/v1/payments/{payment_id}/reversal"
payload = {
"reason": "<string>",
"is_nsf": False
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reason: '<string>', is_nsf: false})
};
fetch('https://api.montereyfinancial.app/v1/payments/{payment_id}/reversal', 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.montereyfinancial.app/v1/payments/{payment_id}/reversal",
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([
'reason' => '<string>',
'is_nsf' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.montereyfinancial.app/v1/payments/{payment_id}/reversal"
payload := strings.NewReader("{\n \"reason\": \"<string>\",\n \"is_nsf\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.montereyfinancial.app/v1/payments/{payment_id}/reversal")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\",\n \"is_nsf\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.montereyfinancial.app/v1/payments/{payment_id}/reversal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\",\n \"is_nsf\": false\n}"
response = http.request(request)
puts response.read_body{
"payment_id": "<string>",
"account_id": "<string>",
"amount_cents": 123,
"payment_method": "<string>",
"check_number": 123,
"status": "<string>",
"effective_date": "2023-12-25",
"external_reference": "<string>",
"memo": "<string>",
"reference_number": 123,
"posted_at": "2023-11-07T05:31:56Z",
"reversal": {
"reversed_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"is_nsf": true,
"reference_number": 123,
"reversed_by": "<string>"
}
}{
"payment_id": "<string>",
"account_id": "<string>",
"amount_cents": 123,
"payment_method": "<string>",
"check_number": 123,
"status": "<string>",
"effective_date": "2023-12-25",
"external_reference": "<string>",
"memo": "<string>",
"reference_number": 123,
"posted_at": "2023-11-07T05:31:56Z",
"reversal": {
"reversed_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"is_nsf": true,
"reference_number": 123,
"reversed_by": "<string>"
}
}{
"detail": {
"error_code": "<string>"
}
}Reverse a payment your organization posted
Reverses a payment posted through this API. Requires an Idempotency-Key header; replaying the same key and body returns the original response. Returns 201 when reversed and 202 when the outcome is still being confirmed (reversal_pending).
curl --request POST \
--url https://api.montereyfinancial.app/v1/payments/{payment_id}/reversal \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"reason": "<string>",
"is_nsf": false
}
'import requests
url = "https://api.montereyfinancial.app/v1/payments/{payment_id}/reversal"
payload = {
"reason": "<string>",
"is_nsf": False
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({reason: '<string>', is_nsf: false})
};
fetch('https://api.montereyfinancial.app/v1/payments/{payment_id}/reversal', 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.montereyfinancial.app/v1/payments/{payment_id}/reversal",
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([
'reason' => '<string>',
'is_nsf' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.montereyfinancial.app/v1/payments/{payment_id}/reversal"
payload := strings.NewReader("{\n \"reason\": \"<string>\",\n \"is_nsf\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.montereyfinancial.app/v1/payments/{payment_id}/reversal")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\",\n \"is_nsf\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.montereyfinancial.app/v1/payments/{payment_id}/reversal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\",\n \"is_nsf\": false\n}"
response = http.request(request)
puts response.read_body{
"payment_id": "<string>",
"account_id": "<string>",
"amount_cents": 123,
"payment_method": "<string>",
"check_number": 123,
"status": "<string>",
"effective_date": "2023-12-25",
"external_reference": "<string>",
"memo": "<string>",
"reference_number": 123,
"posted_at": "2023-11-07T05:31:56Z",
"reversal": {
"reversed_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"is_nsf": true,
"reference_number": 123,
"reversed_by": "<string>"
}
}{
"payment_id": "<string>",
"account_id": "<string>",
"amount_cents": 123,
"payment_method": "<string>",
"check_number": 123,
"status": "<string>",
"effective_date": "2023-12-25",
"external_reference": "<string>",
"memo": "<string>",
"reference_number": 123,
"posted_at": "2023-11-07T05:31:56Z",
"reversal": {
"reversed_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"is_nsf": true,
"reference_number": 123,
"reversed_by": "<string>"
}
}{
"detail": {
"error_code": "<string>"
}
}Authorizations
Short-lived access token minted by POST /v1/oauth/token.
Headers
1 - 255Path Parameters
Body
Response
Successful Response
A payment an organization posted to one of its accounts.
Monterey payment ID.
The account the payment was posted to.
Payment amount, in integer cents.
How the payment was collected.
Check number, when applicable.
pending, posted, pending_confirmation, reversal_pending, reversed or failed.
Date the payment applies.
Your own reference.
Free-text note.
Reference number of the posted payment.
When it was posted.
Reversal details; null unless the payment was reversed.
Show child attributes
Show child attributes