Create a mock wire repayment

In the sandbox environment, initiate a mock wire repayment that simulates an incoming wire payment to repay an outstanding credit transfer. The fiat account will be automatically linked as a repayment account if not already linked.

POST /v1/credit/mocks/repayments

Create a mock wire repayment

cURL

curl --request POST \
  --url https://api-sandbox.circle.com/v1/credit/mocks/repayments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fiatAccountId": "be863d4a-928f-4f54-9af0-c94f5a80ce49",
  "amount": {
    "amount": "3.14",
    "currency": "USD"
  }
}
'

201

{
  "data": {
    "trackingRef": "CIR3AZQ4GS",
    "amount": {
      "amount": "3.14",
      "currency": "USD"
    },
    "status": "pending"
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

fiatAccountId · string<uuid> · required

The ID of the wire bank account to use for the mock repayment. This is the same ID returned by the wire bank accounts endpoint.

Example:

"be863d4a-928f-4f54-9af0-c94f5a80ce49"

amount · object · required

Show child attributes

Response

201

application/json

Successfully created a mock wire repayment.

data · object

Show child attributes