Request

🚧

With the recent publication of ORDINANCE SPA/MF No. 1,231, betting houses in Brazil will need to adapt their processes to align with new regulatory requirements. According to Article 31 of this ordinance, operators must request a specific set of additional data from bettors that were not previously required. Among these new requirements, the need to collect data from deposit accounts or prepaid payment accounts registered by users stands out.

This information is essential to ensure transparency and traceability of financial transactions carried out on betting platforms, strengthening the fight against money laundering and other illicit practices.


POST: https://staging.pay2free.com/v2/deposit/create

Dictionary Deposit

Type
merchant (required)Provided by us, it's an internal ID that identifies the merchant
externalId (required)Client id in your system
cpf (required)Payer document
email (required)Payer's email address
name (required)Payer'sname
phone (required)Payer's phone number
birthday (required)Payer's birthday
value (required)Deposit amount
txid (required)Your transaction ID - Numbers only Limited to 33 characters
bankispb (optional)ISPB code of the user's bank
bankbranch (optional)User's bank branch number
bankaccount (optional)User's bank account number, without the hyphen, but including the check digit


Use the cURL below to start testing:

curl --location 'https://{baseurl}/v2/deposit/create' \
--header 'x-pixer-api-key: Api-Key TOKEN' \
 --header 'Content-Type: application/json' \
 --data-raw '{
 "merchant": "64abf106aa289a9578099537",
 "client": {
     "externalId": "38af8438-6016-4fd5-8049-e66dc427b5d9",
     "cpf": "684.246.313-07",
     "email": "[email protected]",
     "name": "Alexandre Gustavo Galvão",
     "phone": "+5582998950275",
     "birthday": "1960-06-09",
     "bankispb": "000000", // (optional)
     "bankbranch": "0001", // (optional)
     "bankaccount": "00000000" // (optional)
 },
     "value": 0.01,
     "txid": "00000006"
 }



QRCode generation

The return below is presented when a qrcode is requested

Success:

{
    "e2eId": "",
    "pixImage": "data:image/png;base64,i...CCC",
    "pixPayload": "00020101021226990014br.gov.bcb.pix2577...624",
    "status": "processing",
    "value": 5,
    "bank": "641c3e...199",
    "client": "6703ee...35e",
    "expiry": "2024-02-30T00:01:02.345Z",
    "merchant": "654141...878",
    "txid": "181...597",
    "responseStatus": 201
}