Pular para o conteúdo principal
POST

Autorizações

Authorization
string
header
obrigatório

Token de autenticação da API do usuário com o formato cash_<64-char-hex>. Valor de exemplo cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.

Corpo

application/json

Solicitação de criação de transação de saída por um usuário

accountId
string<uuid>
obrigatório

ID da conta do usuário de onde enviar os fundos

Exemplo:

"550e8400-e29b-41d4-a716-446655440123"

amount
number<decimal>
obrigatório

Valor da transação (deve ser positivo)

Exemplo:

15000.5

fromName
string

Nome do remetente da transação

Maximum string length: 255
Exemplo:

"Juan Pérez"

toName
string

Nome do destinatário da transação

Maximum string length: 255
Exemplo:

"María García"

fromCBU
number

CBU (número da conta bancária) do remetente

Exemplo:

170001540000000020000

toCBU
string

CBU do destinatário (22 dígitos). Informe toCBU ou toCVU.

Exemplo:

"1100015400000000000021"

toCVU
string

CVU do destinatário (22 dígitos). Informe toCBU ou toCVU.

Exemplo:

"0000003100012345678901"

fromCUIT
number

CUIT/CUIL do remetente

Exemplo:

20123456789

toCUIT
number

CUIT/CUIL do destinatário

Exemplo:

27987654321

concept
string

Conceito ou descrição da transação

Maximum string length: 500
Exemplo:

"Payment for services"

externalDate
string<date-time>

Data da transação no seu sistema (formato ISO 8601)

Exemplo:

"2024-06-19T10:30:00Z"

coelsaCode
string

Código de transação Coelsa

Maximum string length: 100
Exemplo:

"COELSA123456"

data
object

Dados JSON adicionais da transação

Exemplo:
webhookUrl
string<uri>

URL de webhook opcional para receber atualizações de status desta solicitação

Exemplo:

"https://client.example.com/webhooks/transaction-request"

Resposta

Solicitação de transação criada com sucesso

id
string<uuid>

ID interno da solicitação de transação

Exemplo:

"789e0123-e89b-12d3-a456-426614174999"

externalID
string
Exemplo:

"REQ-2024-001234"

createdAt
string<date-time>
Exemplo:

"2024-06-19T10:30:00Z"

status
enum<string>
Opções disponíveis:
PENDING,
AWAITING_REVIEW,
PROCESSING,
DONE,
ERROR,
CANCELLED
Exemplo:

"PENDING"