Cancel reserved funds

Cancels a funds_reserved transfer and releases the reserved amount back to available credit.

The transfer must be in funds_reserved status for this operation.

Note: This endpoint is only available for Settlement Advance products.

PUT /v1/credit/transfers/{id}/cancelReserve

Cancel reserved funds

cURL

curl --request PUT \
  --url https://api-sandbox.circle.com/v1/credit/transfers/{id}/cancelReserve \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "id": "fc988ed5-c129-4f70-a064-e5beb7eb8e32",
    "amount": {
      "amount": "100000.00",
      "currency": "USD"
    },
    "status": "canceled",
    "createDate": "2024-03-20T14:30:00.000Z",
    "updateDate": "2024-03-20T14:50:00.000Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Response

200

application/json

Successfully canceled the reserved funds.

data · object

A credit transfer (drawdown) from the credit line.

Show child attributes