API Reference

Create a mock PIX payment

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

  • Reference
  • Playground

Initiates a mock PIX payment in the sandbox environment that mimics the behavior of funds sent through the bank account linked to the main wallet.

Body parameters
accountNumber
string
Required

The account number that the money should be transferred to.

amount
object
Required
amount
string
Required

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

currency
string
Required
Allowed valuesBRL
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.

Response
RequestChoose a language
C-LibcurlClojure-clj-httpC#-HttpClientC#-RestSharpGo-NewRequestHTTP-HTTP/1.1Java-AsyncHttpJava-java.net.httpJava-OkHttpJava-UnirestJavaScript-AxiosJavaScript-fetchJavaScript-jQueryJavaScript-XMLHttpRequestJSON-Native JSONKotlin-okhttpNode-AxiosNode-FetchNode-HTTPNode-RequestNode-UnirestObjective-C-NSURLSessionOCaml-CoHTTPPHP-cURLPHP-GuzzlePHP-HTTP v1PHP-HTTP v2Powershell-Invoke-RestMethodPowershell-Invoke-WebRequestPython-RequestsR-httrRuby-net::httpShell-cURLShell-HTTPieShell-WgetSwift-URLSession
ResponseChoose an example
201400401
1{
2  "data": {
3    "trackingRef": "CIR13FB13A",
4    "amount": {
5      "amount": "3.14",
6      "currency": "BRL"
7    },
8    "beneficiaryAccountNumber": "4842622",
9    "status": "pending"
10  }
11}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
Developer TermsService TermsPrivacy PolicyAcceptable UseYour Privacy ChoicesYour Privacy ChoicesCookie Policy