Partially update a payment

curl --request PATCH \
  --url https://api.failfast.ai/treasury/payment/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_fields": null,
  "operation_number": 0,
  "operation_date": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "status_description": "<string>",
  "record": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total": "<string>",
  "operation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "market_exchange_rate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "branch_office": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.failfast.ai/treasury/payment/{id}/"

payload = {
    "custom_fields": None,
    "operation_number": 0,
    "operation_date": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "status_description": "<string>",
    "record": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "total": "<string>",
    "operation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "market_exchange_rate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "branch_office": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payment": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    custom_fields: null,
    operation_number: 0,
    operation_date: '2023-11-07T05:31:56Z',
    description: '<string>',
    status_description: '<string>',
    record: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    total: '<string>',
    operation: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    market_exchange_rate: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    branch_office: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    payment: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.failfast.ai/treasury/payment/{id}/', 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.failfast.ai/treasury/payment/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'custom_fields' => null,
    'operation_number' => 0,
    'operation_date' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'status_description' => '<string>',
    'record' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'total' => '<string>',
    'operation' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'market_exchange_rate' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'branch_office' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'payment' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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.failfast.ai/treasury/payment/{id}/"

	payload := strings.NewReader("{\n  \"custom_fields\": null,\n  \"operation_number\": 0,\n  \"operation_date\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"status_description\": \"<string>\",\n  \"record\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"total\": \"<string>\",\n  \"operation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_exchange_rate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"branch_office\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.failfast.ai/treasury/payment/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_fields\": null,\n  \"operation_number\": 0,\n  \"operation_date\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"status_description\": \"<string>\",\n  \"record\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"total\": \"<string>\",\n  \"operation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_exchange_rate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"branch_office\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.failfast.ai/treasury/payment/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"custom_fields\": null,\n  \"operation_number\": 0,\n  \"operation_date\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"status_description\": \"<string>\",\n  \"record\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"total\": \"<string>\",\n  \"operation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_exchange_rate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"branch_office\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "error": false,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "operation_date": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "record": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "total": "<string>",
    "member": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "operation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "branch_office": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payment": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_fields": null,
    "operation_number": 0,
    "description": "<string>",
    "status_description": "<string>",
    "market_exchange_rate": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

PATCH

treasury

payment

{id}

Partially update a payment

curl --request PATCH \
  --url https://api.failfast.ai/treasury/payment/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_fields": null,
  "operation_number": 0,
  "operation_date": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "status_description": "<string>",
  "record": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total": "<string>",
  "operation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "market_exchange_rate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "branch_office": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.failfast.ai/treasury/payment/{id}/"

payload = {
    "custom_fields": None,
    "operation_number": 0,
    "operation_date": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "status_description": "<string>",
    "record": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "total": "<string>",
    "operation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "market_exchange_rate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "branch_office": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payment": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    custom_fields: null,
    operation_number: 0,
    operation_date: '2023-11-07T05:31:56Z',
    description: '<string>',
    status_description: '<string>',
    record: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    total: '<string>',
    operation: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    market_exchange_rate: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    branch_office: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    payment: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.failfast.ai/treasury/payment/{id}/', 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.failfast.ai/treasury/payment/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'custom_fields' => null,
    'operation_number' => 0,
    'operation_date' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'status_description' => '<string>',
    'record' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'total' => '<string>',
    'operation' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'market_exchange_rate' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'branch_office' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'payment' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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.failfast.ai/treasury/payment/{id}/"

	payload := strings.NewReader("{\n  \"custom_fields\": null,\n  \"operation_number\": 0,\n  \"operation_date\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"status_description\": \"<string>\",\n  \"record\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"total\": \"<string>\",\n  \"operation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_exchange_rate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"branch_office\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.failfast.ai/treasury/payment/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_fields\": null,\n  \"operation_number\": 0,\n  \"operation_date\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"status_description\": \"<string>\",\n  \"record\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"total\": \"<string>\",\n  \"operation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_exchange_rate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"branch_office\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.failfast.ai/treasury/payment/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"custom_fields\": null,\n  \"operation_number\": 0,\n  \"operation_date\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"status_description\": \"<string>\",\n  \"record\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"total\": \"<string>\",\n  \"operation\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"market_exchange_rate\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"branch_office\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payment\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "error": false,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "operation_date": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "record": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "total": "<string>",
    "member": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "operation": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "branch_office": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payment": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_fields": null,
    "operation_number": 0,
    "description": "<string>",
    "status_description": "<string>",
    "market_exchange_rate": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization

string

header

required

Workspace API key sent as a bearer token: Authorization: Bearer failfast_.... Create keys in Settings -> Workspace -> API Keys.

Path Parameters

string<uuid>

required

A UUID string identifying this payment.

Body

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

custom_fields

unknown

operation_number

integer

default:0

Required range: 0 <= x <= 2147483647

operation_date

string<date-time>

description

string | null

operation_status

enum<string>

PR - Provisional
CO - Complete
ER - Error

Available options:

PR,

CO,

ER

status_description

string | null

record

string<uuid>

total

string<decimal>

Pattern: ^-?\d{0,14}(?:\.\d{0,6})?$

payment_status

enum<string>

GE - Generated
BF - Bank File Generated
CO - Confirmed
BD - Bank Deposit

Available options:

GE,

BF,

CO,

BD

operation

string<uuid>

market_exchange_rate

string<uuid> | null

branch_office

string<uuid>

payment

string<uuid>

Response

200 - application/json

message

string

required

Human-readable outcome of the request.

error

boolean

required

true when the request failed.

Example:

false

data

object

required

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

Show child attributes

API documentation

Endpoints

Partially update a payment

Authorizations

Path Parameters

Body

Response