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

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

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

Example:

"CIR13FB13A"

​
amount
object
required
​
accountNumber
string
required

The account number that the money should be transferred to.

Example:

"4842622"

Response

Successfully created a mock PIX payment.

​
data
object