Stop an outbound international wire that has not left the bank and release its funds

POST/transfers/international-wire/{id}/stop

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

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

operatorstringRequired

Who acted

Returns

200 OK

The International Wire 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/transfers/international-wire/{id}/stop' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "operator": "string"
  }'

Response200

{
  "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "amount": 10000,
  "approved_by": "string",
  "charge_bearer": "string",
  "correspondent_bic": "string",
  "cover_bic": "string",
  "cover_msg_id": "string",
  "cover_network_ref": "string",
  "cover_network_status": "string",
  "created_at": "2026-09-17T14:30:00Z",
  "creditor": {
    "account": "string",
    "address": {
      "building_name": "string",
      "building_number": "string",
      "country": "string",
      "country_sub_division": "string",
      "department": "string",
      "district_name": "string",
      "floor": "string",
      "lines": [
        "string"
      ],
      "post_box": "string",
      "post_code": "string",
      "room": "string",
      "street_name": "string",
      "sub_department": "string",
      "town_location_name": "string",
      "town_name": "string"
    },
    "any_bic": "string",
    "country_of_residence": "string",
    "lei": "string",
    "name": "string",
    "other_id": "string",
    "other_id_scheme": "string",
    "private": false
  },
  "creditor_agent_bic": "string",
  "currency_code": "USD",
  "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "debit_amount": 10000,
  "debtor": {
    "account": "string",
    "address": {
      "building_name": "string",
      "building_number": "string",
      "country": "string",
      "country_sub_division": "string",
      "department": "string",
      "district_name": "string",
      "floor": "string",
      "lines": [
        "string"
      ],
      "post_box": "string",
      "post_code": "string",
      "room": "string",
      "street_name": "string",
      "sub_department": "string",
      "town_location_name": "string",
      "town_name": "string"
    },
    "any_bic": "string",
    "country_of_residence": "string",
    "lei": "string",
    "name": "string",
    "other_id": "string",
    "other_id_scheme": "string",
    "private": false
  },
  "debtor_agent_bic": "string",
  "deducted_charges_amount": 10000,
  "direction": "string",
  "end_to_end_id": "string",
  "fee_amount": 10000,
  "fx_quote_id": "string",
  "gl_code": "string",
  "hold_id": "hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "id": "string",
  "instr_id": "string",
  "intermediary_bic": "string",
  "journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "kind": "string",
  "ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "msg_id": "string",
  "network_ref": "string",
  "network_status": "string",
  "operator": "string",
  "original_payment_id": "lpay_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "prepaid_charges_amount": 10000,
  "purpose": "string",
  "queued_until": "2026-09-17T14:30:00Z",
  "reason": "string",
  "remittance": "string",
  "repair_id": "string",
  "return_reason": "string",
  "return_reason_code": "string",
  "returned_amount": 10000,
  "reversal_journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "screening_id": "scrn_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "screening_result": "string",
  "settlement_amount": 10000,
  "settlement_method": "string",
  "status": "string",
  "tracker_reason": "string",
  "tracker_status": "string",
  "uetr": "string",
  "ultimate_creditor": {
    "account": "string",
    "address": {
      "building_name": "string",
      "building_number": "string",
      "country": "string",
      "country_sub_division": "string",
      "department": "string",
      "district_name": "string",
      "floor": "string",
      "lines": [
        "string"
      ],
      "post_box": "string",
      "post_code": "string",
      "room": "string",
      "street_name": "string",
      "sub_department": "string",
      "town_location_name": "string",
      "town_name": "string"
    },
    "any_bic": "string",
    "country_of_residence": "string",
    "lei": "string",
    "name": "string",
    "other_id": "string",
    "other_id_scheme": "string",
    "private": false
  },
  "ultimate_debtor": {
    "account": "string",
    "address": {
      "building_name": "string",
      "building_number": "string",
      "country": "string",
      "country_sub_division": "string",
      "department": "string",
      "district_name": "string",
      "floor": "string",
      "lines": [
        "string"
      ],
      "post_box": "string",
      "post_code": "string",
      "room": "string",
      "street_name": "string",
      "sub_department": "string",
      "town_location_name": "string",
      "town_name": "string"
    },
    "any_bic": "string",
    "country_of_residence": "string",
    "lei": "string",
    "name": "string",
    "other_id": "string",
    "other_id_scheme": "string",
    "private": false
  },
  "updated_at": "2026-09-17T14:30:00Z",
  "value_date": "2026-09-17"
}