API Reference

Create a mock Wire payment

posthttps://api-sandbox.circle.com/v1/mocks/payments/wire

  • Reference
  • Playground

In the sandbox environment, initiate a mock wire payment that mimics the behavior of funds sent through the bank (wire) account linked to master wallet.

Body parameters
beneficiaryBank
object
Required
accountNumber
string
Required

Virtual account number or Circle corporate Silvergate Wire account number that needs to be set as destination.

amount
object
Required
amount
string
Required

Magnitude of the amount, in units of the currency, with a ..

currency
string
Required

Currency code.

Allowed valuesUSD
trackingRef
string
Required

Wire tracking reference that needs to be set in the wire reference to beneficiary field. This field is retrievable through the response during wire creation or via the bank instruction endpoint.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "data": {
3    "trackingRef": "CIR13FB13A",
4    "amount": {
5      "amount": "3.14",
6      "currency": "USD"
7    },
8    "beneficiaryBank": {
9      "accountNumber": "11111111"
10    },
11    "status": "pending"
12  }
13}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.