Create Transfer - Documentação DEVMOB

curl --request POST \ --url https://api.example.com/api/v1/ops/transfers \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "amount": 50000 } '

{ "transferId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "bankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "externalProvider": "<string>", "externalProviderId": "<string>", "amount": 123, "transferredAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z" }

curl --request POST \ --url https://api.example.com/api/v1/ops/transfers \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "amount": 50000 } '

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields

string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

amount

integer

required

Transfer amount in cents

Example:

50000

Response

Created

Transferências de recebíveis acumulados para conta bancária

transferId

string<uuid>

required

Identificador único

organizationId

string<uuid>

required

Referência à organização da empresa beneficiária

companyId

string<uuid>

required

Referência à empresa beneficiária

bankAccountId

string<uuid>

required

Referência à conta bancária

externalProvider

string

required

Nome do provedor externo

externalProviderId

string

required

ID da transferência no provedor externo

amount

integer

required

Valor da transferência em centavos

status

enum<string>

required

Status da transferência

Available options:

PENDING,

PROCESSING,

PAID,

FAILED,

CANCELED

transferredAt

string<date-time> | null

required

Data em que a transferência foi efetivada

createdBy

string<uuid> | null

required

Usuário que criou o registro, quando aplicável

createdAt

string<date-time>

required

Data de criação

updatedBy

string<uuid> | null

required

Usuário que fez a última atualização, quando aplicável

updatedAt

string<date-time>

required

Data da última atualização