Skip to content
FSCO API Docs

Update Wire Status

PATCH
/wires/{wireId}/status

Update the status of a wire transfer (admin endpoint).

Authorizations

Parameters

Path Parameters

wireId
required
string format: uuid

Wire transfer ID

Request Body required

object
status
required

Status of wire transfer

string
Allowed values: pending processing completed failed cancelled
reason

Optional reason for the status update

string
Customer requested cancellation

Responses

200

Wire status updated

object
id

Unique identifier for the wire

string format: uuid 
123e4567-e89b-12d3-a456-426614174000
status

Status of wire transfer

string
Allowed values: pending processing completed failed cancelled
type

Type of wire transfer

string
Allowed values: on-ramp off-ramp transfer
sourceType

Type of asset

string
Allowed values: fiat stablecoin
sourceCurrency

Currency code of the source

string
USD
sourceAmount

Amount transferred from source

string
1000.00
sourceDetails

Additional details specific to source type

object 
{
  "bankName": "Example Bank",
  "accountNumber": "123456789",
  "accountHolderName": "John Doe"
}
destinationType

Type of asset

string
Allowed values: fiat stablecoin
destinationCurrency

Currency code of the destination

string
USDC
destinationAmount

Amount received at destination

string
998.50
destinationDetails

Additional details specific to destination type

object 
{
  "walletAddress": "0x1234567890abcdef1234567890abcdef12345678"
}
createdAt

Date and time the wire was created

string format: date-time 
2023-10-01T12:00:00Z
updatedAt

Date and time the wire was last updated

string format: date-time 
2023-10-01T12:15:00Z
completedAt

Date and time the wire was completed

string format: date-time 
2023-10-01T12:30:00Z
txHashes

Blockchain transaction hashes

Array<string>
[
  "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
]
externalReferences

External reference numbers keyed by their type

object
key
additional properties
string
{
  "bankReference": "REF123456",
  "blockchainTx": "0xabcdef1234"
}
reference

Customer reference for the wire

string
Invoice-12345
notes

Additional notes about the wire

string
Payment for services

400

Bad Request

object
message
string
Invalid input data
details
string
Source amount must be a valid number

404

Resource Not Found

object
message
string
Wire transfer not found
details
string
No wire transfer found with ID 123e4567-e89b-12d3-a456-426614174000