Solicitação de depósito via Pix

POST

/api/partner/v1/cash-in

Permite requisição de pagamento Pix. IP e chave de API devem ser autorizados. Após o processamento, webhooks de criação ou atualização serão enviados para a callbackUrl fornecida.

Requisição

Authorization

Bearer Token

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK

application/json

Requisição de Cash-in recebida com sucesso. O resultado será enviado para a callbackUrl.

Bodyapplication/json

🟠401Não autorizado

🟠422Erro de parâmetro

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/partner/v1/cash-in' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 14.67,
    "description": "Teste",
    "webhook_url": "https://site.com/webhook",
    "client": {
        "name": "Roberto",
        "cpf": "12345678900",
        "email": "roberto@test.com",
        "phone": "51123123123"
    },
    "split": [
        {
            "percentage": 10,
            "user_id": "9f3c5b3a-41bc-4322-90e6-a87a98eefeca"
        }
    ]
}'

Response Example

200 - Sucesso

{
    "message": "Cashin request successfully submitted",
    "pix_code": "00020126820014br.gov.bcb.pix...",
    "identifier": "3df0319d-ecf7-455a-84c4-070aee2779c1"
}

Modificado em 2026-03-04 20:50:08