Skip to main content
Financial Actions

Create a governed credit, collection or corporate action from a sealed source record

POST /actions/credit-corporate

Contract

Creates a canonical Action Envelope only after amount, currency, counterparty and source-record scope are validated. Supported execution modes are sandbox and approval-gated live; this endpoint does not execute the action.

Authentication
Bearer credential required
Required scope
actions:create
Status
Published

Request body

application/json ยท required
{
    "action_key": "loan_repayment",
    "source_uid": "00000000-0000-4000-8000-000000000001",
    "arrangement_uid": "00000000-0000-4000-8000-000000000001",
    "connector_id": 1,
    "counterparty_id": 1,
    "currency": "string",
    "amount": 1,
    "purpose": "string",
    "external_reference": "string",
    "calculation_source": "string",
    "calculation_reference": "string",
    "execution_mode": "sandbox"
}

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 '{
    "action_key": "loan_repayment",
    "source_uid": "00000000-0000-4000-8000-000000000001",
    "arrangement_uid": "00000000-0000-4000-8000-000000000001",
    "connector_id": 1,
    "counterparty_id": 1,
    "currency": "string",
    "amount": 1,
    "purpose": "string",
    "external_reference": "string",
    "calculation_source": "string",
    "calculation_reference": "string",
    "execution_mode": "sandbox"
}' \
  "https://financegpt.dev/api/v2/actions/credit-corporate"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/actions\/credit-corporate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "action_key": "loan_repayment",
    "source_uid": "00000000-0000-4000-8000-000000000001",
    "arrangement_uid": "00000000-0000-4000-8000-000000000001",
    "connector_id": 1,
    "counterparty_id": 1,
    "currency": "string",
    "amount": 1,
    "purpose": "string",
    "external_reference": "string",
    "calculation_source": "string",
    "calculation_reference": "string",
    "execution_mode": "sandbox"
}),
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/actions/credit-corporate',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
    json=json.loads('{"action_key":"loan_repayment","source_uid":"00000000-0000-4000-8000-000000000001","arrangement_uid":"00000000-0000-4000-8000-000000000001","connector_id":1,"counterparty_id":1,"currency":"string","amount":1,"purpose":"string","external_reference":"string","calculation_source":"string","calculation_reference":"string","execution_mode":"sandbox"}'),
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/actions/credit-corporate');
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 (
  'action_key' => 'loan_repayment',
  'source_uid' => '00000000-0000-4000-8000-000000000001',
  'arrangement_uid' => '00000000-0000-4000-8000-000000000001',
  'connector_id' => 1,
  'counterparty_id' => 1,
  'currency' => 'string',
  'amount' => 1.0,
  'purpose' => 'string',
  'external_reference' => 'string',
  'calculation_source' => 'string',
  'calculation_reference' => 'string',
  'execution_mode' => 'sandbox',
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
201 Source-bound Financial Action created; required domain controls must pass before approval
422 Source

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