Transações

O livro-razão da sua carteira

GET/transactions
GET/transactions/{transactionId}

O objeto Transação

Atributos

idnumber <int64>somente leitura
ID interno da transação.
uidstringsomente leitura
UID da transação.
typestring
credit (entrada de dinheiro) ou debit (saída de dinheiro).
Valores permitidos:debitcreditrefund
pelo menos 1 caracteres
transTypestring
Para que serve a transação, por exemplo Payment, Shipment ou Recharge.
Valores permitidos:ShipmentPaymentMoney TransferAdjustmenFee
pelo menos 1 caracteres
statestring
Estado de liquidação, por exemplo cleared ou pending.
Valores permitidos:clearedpending
pelo menos 1 caracteres
referenceNostring
Número de referência do pagamento ou do serviço.
pelo menos 1 caracteres
descriptionstring
Descrição da transação.
pelo menos 1 caracteres
courierNamestringaceita null
Transportadora do envio, nas cobranças de envios.
pelo menos 1 caracteres
amountnumber
Valor, USD.
pelo menos 1 caracteres
balancenumber
Saldo da carteira depois desta transação, USD.
pelo menos 1 caracteres
accountIdnumber
ID interno da conta à qual a transação pertence.
pelo menos 1 caracteres
adjustmentTypeIdnumberaceita null
ID interno do ajuste, nos ajustes manuais.
pelo menos 1 caracteres
createdAtstring <date-time>
Quando a transação foi registrada.
pelo menos 1 caracteres
updatedAtstring <date-time>
Quando a transação mudou pela última vez.
pelo menos 1 caracteres

O objeto Transação

{
  "id": 1,
  "uid": "3s91olwt4rs47np8cctft3pmgiwoy7hvnw01",
  "type": "credit",
  "transType": "Payment",
  "state": "cleared",
  "referenceNo": "P2Y2P8XAEUS",
  "description": "Card payment received (test stripe pi_test_p2y2p8xaeus)",
  "courierName": null,
  "amount": 25,
  "balance": 25,
  "accountId": 1,
  "adjustmentTypeId": null,
  "createdAt": "2026-11-01T00:37:54.000Z",
  "updatedAt": "2026-11-01T00:37:54.000Z"
}

Listar transações da carteira

GET/transactions

Requer um token de acesso

Lista os lançamentos do livro-razão da sua carteira WeShipYou: pagamentos recebidos, cobranças de serviços, reembolsos e tarifas.

Parâmetros de consulta

accountIdstring
Limita os resultados a uma das suas contas: o seu uid, o seu número de conta (CU…) ou o seu número de conta externo. Sem ele, todas as contas das quais você faz parte são incluídas.
$limitnumber
Número máximo de resultados (padrão 20).
Padrão: 20
>= 0 · <= 500
$skipnumber
Número de resultados a ignorar, para paginação.
Padrão: 0
>= 0

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

Uma página de transações

totalnumber
limitnumber
skipnumber
datalista de Transação
O objeto Transação

401

Token de acesso ausente ou inválido

namestring
Sempre NotAuthenticated
messagestring
codenumber
Sempre 401
classNamestring
Sempre not-authenticated
dataobject

403

Você não tem acesso a esta conta

namestring
Sempre Forbidden
messagestring
codenumber
Sempre 403
classNamestring
Sempre forbidden
dataobject

GET/transactions

curl 'https://sandbox.weshipyou.com/api/v1/transactions' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Resposta

{
  "total": 1,
  "limit": 20,
  "skip": 0,
  "data": [
    {
      "id": 1,
      "uid": "3s91olwt4rs47np8cctft3pmgiwoy7hvnw01",
      "type": "credit",
      "transType": "Payment",
      "state": "cleared",
      "referenceNo": "P2Y2P8XAEUS",
      "description": "Card payment received (test stripe pi_test_p2y2p8xaeus)",
      "courierName": null,
      "amount": 25,
      "balance": 25,
      "accountId": 1,
      "adjustmentTypeId": null,
      "createdAt": "2026-11-01T00:37:54.000Z",
      "updatedAt": "2026-11-01T00:37:54.000Z"
    }
  ]
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.

Obter uma transação da carteira

GET/transactions/{transactionId}

Requer um token de acesso

Retorna um lançamento do livro-razão da sua carteira.

Parâmetros de caminho

transactionIdstringobrigatório
O uid da transação.

Parâmetros de cabeçalho

Accept-Languagestring
Código de duas letras do idioma das mensagens: en, es ou pt.
Padrão: en-US

Respostas

200

A transação

O objeto Transação

401

Token de acesso ausente ou inválido

namestring
Sempre NotAuthenticated
messagestring
codenumber
Sempre 401
classNamestring
Sempre not-authenticated
dataobject

404

Nenhum envio tem esse id

namestring
Sempre NotFound
messagestring
codenumber
Sempre 404
classNamestring
Sempre not-found
dataobject

GET/transactions/{transactionId}

curl 'https://sandbox.weshipyou.com/api/v1/transactions/{transactionId}' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN"

Resposta

{
  "id": 1,
  "uid": "3s91olwt4rs47np8cctft3pmgiwoy7hvnw01",
  "type": "credit",
  "transType": "Payment",
  "state": "cleared",
  "referenceNo": "P2Y2P8XAEUS",
  "description": "Card payment received (test stripe pi_test_p2y2p8xaeus)",
  "courierName": null,
  "amount": 25,
  "balance": 25,
  "accountId": 1,
  "adjustmentTypeId": null,
  "createdAt": "2026-11-01T00:37:54.000Z",
  "updatedAt": "2026-11-01T00:37:54.000Z"
}

ExperimenteEnvie uma solicitação real para o ambiente Teste desta página, sem escrever código.