Create a payable remittance

POST/payable-remittances

Fresh verified staff with payments:operations:write authority is required. Capture exact registered source obligations and requested principal allocations, reviewed recipient, settlement date and reference. Proposal alone neither pays the recipient nor extinguishes the liability. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

agency_report_idstringOptional

AgencyReportID names the accepted unclaimed property holder report an unclaimed property remittance pays; omitted otherwise.

Example strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm

allocationsarray of objectsRequired

2 child attributes

amount_minorintegerRequired

obligation_idstringRequired

recipient_idstringRequired

referencestringRequired

settlement_datestring · dateRequired

A business date, YYYY-MM-DD

Returns

200 OK

The Payable Remittance object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/payable-remittances' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "allocations": [
      {
        "amount_minor": 0,
        "obligation_id": "string"
      }
    ],
    "recipient_id": "string",
    "reference": "string",
    "settlement_date": "2026-09-17"
  }'

Response200

{
  "actor": "string",
  "content_sha256": "string",
  "created_at": "2026-09-17T14:30:00Z",
  "decision": {
    "actor": "string",
    "at": "2026-09-17T14:30:00Z",
    "content_sha256": "string",
    "decision": "string",
    "reason": "string"
  },
  "id": "string",
  "instruction": {
    "allocations": [
      {
        "amount_minor": 0,
        "obligation_id": "string",
        "source_sha256": "string"
      }
    ],
    "amount_minor": 0,
    "currency": "USD",
    "destination": {
      "account_number": "string",
      "legal_name": "string",
      "routing_number": "string"
    },
    "environment": "string",
    "id": "string",
    "issued_at": "2026-09-17T14:30:00Z",
    "key_id": "string",
    "legal_entity": "string",
    "master_cash_external_account_reference": "string",
    "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "network_reference": "string",
    "outbound_message_sha256": "string",
    "payee_control_id": "string",
    "payee_sha256": "string",
    "protocol": "string",
    "provider": "string",
    "rail": "string",
    "settlement_date": "2026-09-17",
    "version": "string"
  },
  "obligations": [
    {
      "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "amount_minor": 0,
      "content_sha256": "string",
      "created_at": "2026-09-17T14:30:00Z",
      "currency": "USD",
      "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "evidence_reference": "string",
      "hold_id": "hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "id": "string",
      "issuer": "string",
      "jurisdiction": "string",
      "kind": "string",
      "legal_entity": "string",
      "loan_id": "loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "payee_reference": "string",
      "source": {
        "closure_component": "string",
        "closure_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "journal_key": "string",
        "journal_sha256": "string",
        "ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm"
      },
      "source_date": "2026-09-17",
      "source_date_basis": "string",
      "source_id": "string",
      "source_sha256": "string",
      "tax_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "tax_period": "string"
    }
  ],
  "outbound_message": "string",
  "recipient": {
    "actor": "string",
    "agency": {
      "child_support": {
        "application_id": "string",
        "case_id": "case_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "disbursement_unit": "string",
        "fips": "string",
        "medical_support": "string",
        "ncp_identifier_id": "string",
        "ncp_identifier_last4": "string",
        "ncp_name": "string",
        "order_evidence_reference": "string",
        "order_evidence_sha256": "string",
        "state": "string"
      },
      "levy": {
        "notice": {},
        "notice_evidence_reference": "string",
        "notice_evidence_sha256": "string",
        "taxpayer_identifier_id": "string"
      },
      "tax_deposit": {
        "deposit_schedule": "string",
        "enrollment_evidence_reference": "string",
        "enrollment_evidence_sha256": "string",
        "form": "string",
        "schedule_evidence_reference": "string",
        "schedule_evidence_sha256": "string",
        "tax_year": 0,
        "taxpayer_ein": "string",
        "taxpayer_name": "string"
      },
      "unclaimed_property": {
        "enrollment_evidence_reference": "string",
        "enrollment_evidence_sha256": "string",
        "holder": {},
        "portal_holder_id": "string",
        "state": "string"
      }
    },
    "authority_evidence_reference": "string",
    "authority_evidence_sha256": "string",
    "content_sha256": "string",
    "created_at": "2026-09-17T14:30:00Z",
    "decision": {
      "actor": "string",
      "at": "2026-09-17T14:30:00Z",
      "content_sha256": "string",
      "decision": "string",
      "reason": "string"
    },
    "destination": {
      "account_number": "string",
      "legal_name": "string",
      "routing_number": "string"
    },
    "environment": "string",
    "id": "string",
    "jurisdiction": "string",
    "key_id": "string",
    "kind": "string",
    "legal_entity": "string",
    "loan_id": "loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "master_cash_external_account_reference": "string",
    "payee_reference": "string",
    "protocol": "string",
    "provider": "string",
    "public_key": "string",
    "receiving_bank_name": "string",
    "revocation": {
      "actor": "string",
      "at": "2026-09-17T14:30:00Z",
      "reason": "string"
    },
    "valid_from": "2026-09-17",
    "valid_through": "2026-09-17"
  },
  "request": {
    "agency_report_id": "strp_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "allocations": [
      {
        "amount_minor": 0,
        "obligation_id": "string"
      }
    ],
    "recipient_id": "string",
    "reference": "string",
    "settlement_date": "2026-09-17"
  },
  "reservation": {
    "actor": "string",
    "content_sha256": "string",
    "created_at": "2026-09-17T14:30:00Z",
    "instruction": {
      "allocations": [
        {}
      ],
      "amount_minor": 0,
      "currency": "USD",
      "destination": {
        "account_number": "string",
        "legal_name": "string",
        "routing_number": "string"
      },
      "environment": "string",
      "id": "string",
      "issued_at": "2026-09-17T14:30:00Z",
      "key_id": "string",
      "legal_entity": "string",
      "master_cash_external_account_reference": "string",
      "master_cash_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "network_reference": "string",
      "outbound_message_sha256": "string",
      "payee_control_id": "string",
      "payee_sha256": "string",
      "protocol": "string",
      "provider": "string",
      "rail": "string",
      "settlement_date": "2026-09-17",
      "version": "string"
    },
    "master_hold_id": "hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
    "outbound_message": "string",
    "proposed_by": "string",
    "recipient": {
      "actor": "string",
      "agency": {
        "child_support": {},
        "levy": {},
        "tax_deposit": {},
        "unclaimed_property": {}
      },
      "authority_evidence_reference": "string",
      "authority_evidence_sha256": "string",
      "content_sha256": "string",
      "created_at": "2026-09-17T14:30:00Z",
      "decision": {
        "actor": "string",
        "at": "2026-09-17T14:30:00Z",
        "content_sha256": "string",
        "decision": "string",
        "reason": "string"
      },
      "destination": {
        "account_number": "string",
        "legal_name": "string",
        "routing_number": "string"
      },
      "environment": "string",
      "id": "string",
      "jurisdiction": "string",
      "key_id": "string",
      "kind": "string",
      "legal_entity": "string",
      "loan_id": "loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "master_cash_external_account_reference": "string",
      "payee_reference": "string",
      "protocol": "string",
      "provider": "string",
      "public_key": "string",
      "receiving_bank_name": "string",
      "revocation": {
        "actor": "string",
        "at": "2026-09-17T14:30:00Z",
        "reason": "string"
      },
      "valid_from": "2026-09-17",
      "valid_through": "2026-09-17"
    },
    "review_sha256": "string",
    "reviewed_at": "2026-09-17T14:30:00Z",
    "reviewed_by": "string"
  }
}