Create

POST

/api/user/transfers

Este endpoint permite realizar uma transferência de valores para uma conta previamente cadastrada por um recebedor autenticado.
A transferência pode ser feita via PIX ou Transferência Bancária (BANK_TRANSFER), dependendo do método especificado.

✅ Requisitos da Requisição

Método HTTP: POST

Endpoint: /api/user/transfers

Content-Type: application/json

Autenticação: api_token

🧠 Header da requisição

Campo	Tipo	Obrigatório	Descrição
`x-api-key`	string	Sim	Token de autenticação API Key
`User-Agent`	AtivoB2B/1.0	Sim

📥 Corpo da Requisição (Request Body)

Campo	Tipo	Obrigatório	Descrição
`amount`	number	Sim	Valor a ser transferido em centavos ou na unidade monetária definida.
`method`	string	Sim	Método da transferência: `PIX` ou `BANK_TRANSFER`.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/user/transfers' \
--header 'x-api-key: {Token}' \
--header 'User-Agent: AtivoB2B/1.0' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": 100,
  "method": "PIX"
}'

Response Example

200 - Success

{
    "message": "Transferência realizada com sucesso.",
    "data": {
        "transfer": [
            {
                "id": "********-****-****-****-************",
                "amount": 500,
                "type": "PIX",
                "status": "INPROCESS",
                "fee": 0,
                "externalRef": null,
                "pixKey": "*************",
                "paidAt": null,
                "typePayment": null,
                "refundedAmount": 0,
                "description": null,
                "receiptUrl": null,
                "endToEndId": null,
                "error": null,
                "payeeId": null,
                "sellerId": "********-****-****-****-************",
                "gatewayId": "********-****-****-****-************",
                "subAccountId": null,
                "createdAt": "2025-04-16T17:46:32.084Z",
                "updatedAt": "2025-04-16T17:46:32.135Z"
            }
        ]
    },
    "status": 200,
    "error": null
}

Modified at 2025-07-23 19:02:40

Find payment methods

Update

Create

✅ Requisitos da Requisição#

🧠 Header da requisição#

📥 Corpo da Requisição (Request Body)#

Request

Responses

✅ Requisitos da Requisição

🧠 Header da requisição

📥 Corpo da Requisição (Request Body)