Skip to main content
POST
/
v1
/
mocks
/
payments
/
wire
Create a mock Wire payment
curl --request POST \
  --url https://api-sandbox.circle.com/v1/mocks/payments/wire \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "trackingRef": "CIR13FB13A",
  "amount": {
    "amount": "3.14",
    "currency": "USD"
  },
  "beneficiaryBank": {
    "accountNumber": "11111111"
  },
  "memo": "<string>"
}
'
{
  "data": {
    "trackingRef": "CIR13FB13A",
    "amount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "beneficiaryBank": {
      "accountNumber": "11111111"
    },
    "status": "pending"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.circle.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
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.

Example:

"CIR13FB13A"

​
amount
object
required
​
beneficiaryBank
object
required
​
memo
string

Optional free-form text memo for client reference information.

Response

Successfully created a mock wire payment.

​
data
object