POST

Release an external payment

ENDPOINT/v1/external-payments/{external_payment_id}/release

Drops a PENDING external-payment hold without posting to the ledger. amount may be less than remaining pending for a partial release. Settled, canceled, released-in-full, or reversed records reject this transition. Send Idempotency-Key so a retried release returns the original result instead of applying twice.

Authentication & Headers

Header	Type	Requirement	Description
Authorization	string	REQUIRED	API key passed as an HTTP Bearer token: `Bearer rk_live_...`
X-Program-ID	UUID	PROGRAM-SCOPED	Program boundary UUID that scopes the issuing card, wallet, or transfer.
Content-Type	string	REQUIRED	Must be `application/json`.
Idempotency-Key	string	OPTIONAL	Unique UUID to prevent duplicate execution of financial creations or mutations.

Path Parameters

Parameter	Type	Requirement	Description
external_payment_id	string	REQUIRED	Unique identifier of the transaction (this endpoint addresses transactions of one type).

Request Body Schema

application/json

amountobject

REQUIRED

Size to release now. Must be positive and not greater than the remaining pending amount.

Properties of amount

amountanyrequired

currencystringrequired

ISO 4217 alphabetic currency code.

Response Codes & Schemas

200The external payment after the hold was released.

application/json

{
  "id": "2c7b9e14-5a80-4d36-b1f8-9e3c6a0d5281",
  "object": "transaction",
  "type": "EXTERNAL_PAYMENT",
  "status": "RELEASED",
  "transfer_ids": [
    "6f2d8a41-3c7e-4b95-a1d0-8e5c2f7b9a63"
  ],
  "amount": {
    "amount": 250000,
    "currency": "USD"
  },
  "wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
  "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
  "direction": "CREDIT",
  "category": "EXTERNAL_WIRE",
  "memo": "Inbound wire from correspondent",
  "events": [
    {
      "id": "6d9f1a47-8e24-4b57-c0d3-7a5e2f6b9408",
      "type": "CREATED",
      "amount": {
        "amount": 250000,
        "currency": "USD"
      },
      "result": "APPROVED",
      "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
      "created_at": "2026-08-26T09:00:00Z"
    },
    {
      "id": "8f1b3c69-0a46-4d79-e2f5-9c7a4b8d1620",
      "type": "RELEASED",
      "amount": {
        "amount": 250000,
        "currency": "USD"
      },
      "result": "APPROVED",
      "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
      "created_at": "2026-08-26T15:00:00Z"
    }
  ],
  "created_at": "2026-08-26T09:00:00Z",
  "updated_at": "2026-08-26T15:00:00Z",
  "effective_date": "2026-08-26"
}

400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.

application/json

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}

401Unauthorized: missing, malformed, or unknown API key.

application/json

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}

403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.

application/json

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}

404Not Found: unknown id, or the resource is not visible to this API key.

application/json

{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}

409Conflict: incompatible state, or Idempotency-Key reused with a different body.

application/json

{
  "error": {
    "type": "conflict_error",
    "code": "conflict",
    "message": "The card cannot be reissued from its current state.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/conflict"
  }
}

422Unprocessable Entity: the document is valid JSON but violates a business rule.

application/json

{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_funds",
    "message": "The source financial account does not have enough available balance.",
    "param": "amount",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/insufficient_funds"
  }
}

429Too Many Requests: the API key exceeded its rate limit.

application/json

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}

500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.

application/json

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}