CorebanqCorebanq Developer Docs
Ledgersv2Holds

Create administrative hold - V2

Places a new hold on a ledger balance. This reduces the available balance while leaving the posted balance unchanged.

POST
/v2/ledgers/holds

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v2/ledgers/holds" \  -H "Content-Type: application/json" \  -d '{    "ledger_id": "baa10cc3-8899-4531-a9c5-63cd06cd8d2c",    "amount": 0,    "reason": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "ledger_id": "baa10cc3-8899-4531-a9c5-63cd06cd8d2c",
  "amount": {
    "amount": "123456",
    "currency": "EUR",
    "precision": 2
  },
  "status": "active",
  "reason": "string",
  "expires_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z"
}
Empty
Empty
Empty

POSTCreate transfer between ledgers

Create a transfer transaction between two ledgers in the same currency. The amount is posted as given — no step on this path converts it — so a source and a destination denominated differently are refused with 400 `ledgers.currency_mismatch` before anything is debited. The transfer is created pending, with the amount parked on the transit ledger configured for that currency (`ledgers.transit_ledgers.{CCY}`); the `complete_transfer` link settles it onto the destination off the same transit ledger the response records in `transit_ledger_id`.

POSTRelease administrative hold - V2

Releases an active hold and restores the available balance. The operation is idempotent: releasing a hold that is already released succeeds and does not restore the balance a second time.