Skip to main content
Financial Actions

Register an accepted settlement or repayment arrangement

POST /actions/credit-corporate/arrangements

Contract

Authentication
Bearer credential required
Required scope
actions:create
Status
Published

Request body

application/json ยท required
{
    "obligation_uid": "00000000-0000-4000-8000-000000000001",
    "arrangement_type": "string",
    "source_reference": "string",
    "source_hash": "string",
    "terms_hash": "string",
    "currency": "string",
    "agreed_amount": 1,
    "discount_amount": 0,
    "installment_count": 1,
    "starts_on": "2026-08-16",
    "expires_on": "2026-08-16",
    "status": "string"
}

Code examples

These examples compose a request only. Public reference pages never transmit your credential or execute the operation.

curl

curl -X POST \
  -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data '{
    "obligation_uid": "00000000-0000-4000-8000-000000000001",
    "arrangement_type": "string",
    "source_reference": "string",
    "source_hash": "string",
    "terms_hash": "string",
    "currency": "string",
    "agreed_amount": 1,
    "discount_amount": 0,
    "installment_count": 1,
    "starts_on": "2026-08-16",
    "expires_on": "2026-08-16",
    "status": "string"
}' \
  "https://financegpt.dev/api/v2/actions/credit-corporate/arrangements"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/actions\/credit-corporate\/arrangements", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "obligation_uid": "00000000-0000-4000-8000-000000000001",
    "arrangement_type": "string",
    "source_reference": "string",
    "source_hash": "string",
    "terms_hash": "string",
    "currency": "string",
    "agreed_amount": 1,
    "discount_amount": 0,
    "installment_count": 1,
    "starts_on": "2026-08-16",
    "expires_on": "2026-08-16",
    "status": "string"
}),
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/actions/credit-corporate/arrangements',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
    json=json.loads('{"obligation_uid":"00000000-0000-4000-8000-000000000001","arrangement_type":"string","source_reference":"string","source_hash":"string","terms_hash":"string","currency":"string","agreed_amount":1,"discount_amount":0,"installment_count":1,"starts_on":"2026-08-16","expires_on":"2026-08-16","status":"string"}'),
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/actions/credit-corporate/arrangements');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'),
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode(array (
  'obligation_uid' => '00000000-0000-4000-8000-000000000001',
  'arrangement_type' => 'string',
  'source_reference' => 'string',
  'source_hash' => 'string',
  'terms_hash' => 'string',
  'currency' => 'string',
  'agreed_amount' => 1.0,
  'discount_amount' => 0,
  'installment_count' => 1,
  'starts_on' => '2026-08-16',
  'expires_on' => '2026-08-16',
  'status' => 'string',
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
201 Accepted arrangement registered and bound to its obligation
422 Invalid arrangement or evidence hash

Authority boundary

A developer credential proves application identity and permits only its scopes. It does not grant model promotion, policy override, QLM rebinding, or Financial Actions execution authority unless those separate controls are satisfied.

actions:create

Machine-readable sources