Adicionar fundos

Adicione dinheiro à sua carteira

POST/add-funds

O objeto Solicitação de fundos

O crédito registrado na carteira. Dependendo do método de pagamento, a conta é retornada em result.account ou em account; uma requisição que só registra um pagamento pendente responde { "ok": true }.

Atributos

okboolean
O pagamento foi registrado e será creditado quando for confirmado.
Sempre true
resultobject
Atributos aninhados
- accountConta
  A conta depois do crédito.
  Atributos aninhados
  namestringobrigatório
  pelo menos 1 caracteres
  displayNamestringobrigatório
  pelo menos 1 caracteres
  systemUnitsstringobrigatório
  Valores permitidos:imperialmetric
  emailstringobrigatório
  pelo menos 1 caracteres
  notificationEmailstringobrigatório
  pelo menos 1 caracteres
  websitestringobrigatórioaceita null
  phonestringobrigatórioaceita null
  pelo menos 1 caracteres
  emergencyPhonestringobrigatórioaceita null
  pelo menos 1 caracteres
  taxIdstringaceita null
  taxIdCountryobjectaceita null
  Atributos aninhados
  isoCodestringobrigatório
  uidstringsomente leitura
  accountNumberstringsomente leitura
  parentUidstringaceita nullsomente leitura
  O uid da conta principal quando esta é uma subconta; null caso contrário.
  statusstringsomente leitura
  languagestringobrigatório
  isBusinessboolean | integerobrigatório
  allowBankAccountPaymentsboolean | integersomente leitura
  metadataobjectaceita nullsomente leitura
  createdAtstring <date-time>somente leitura
  updatedAtstring <date-time>somente leitura
  deletedAtstring <date-time>aceita nullsomente leitura
  addressIdnumberaceita nullsomente leitura
  billingAddressIdnumberaceita nullsomente leitura
  defaultShipFromIdnumberaceita nullsomente leitura
  defaultAddressOnLabelIdnumberaceita nullsomente leitura
  defaultReturnAddressIdnumberaceita nullsomente leitura
  primaryPaymentShipmentsIdnumberaceita nullsomente leitura
  logoIdnumberaceita nullsomente leitura
  pickupServiceFallbackIdnumberaceita nullsomente leitura
  revisionnumberaceita nullsomente leitura
  addressEndereço da conta | object
  Endereço principal da conta.
  Atributos aninhados
  Um de
  uidstringobrigatórioaceita null
  UID do endereço. Use-o como accountAddressId, ou como uid do remetente / destinatário em um envio.
  nicknamestringaceita null
  Nome exibido nos catálogos de endereços.
  namestringaceita null
  Nome do contato.
  companyNamestringaceita null
  Nome da empresa.
  taxIdstringaceita null
  Documento fiscal do contato.
  emailstringaceita null
  E-mail do contato.
  phonestringaceita null
  Telefone do contato, E.164.
  birthdaystring <date-time>aceita null
  Data de nascimento do contato, quando coletada.
  isRecipientboolean | integeraceita null
  O endereço pode receber envios. 1/true ou 0/false.
  isSenderboolean | integeraceita null
  O endereço pode enviar envios. 1/true ou 0/false.
  isResidentialboolean | integeraceita null
  O endereço é residencial. 1/true ou 0/false.
  statusstringobrigatórioaceita null
  Status do registro.
  addressobjectaceita null
  Endereço postal. Incluído quando o endereço é lido sozinho.
  Atributos aninhados
  cityobject
  Atributos aninhados
  namestringaceita null
  stateobject
  Atributos aninhados
  streetstring
  Endereço, incluindo o número do prédio ou apartamento.
  postalCodestring
  countryobjectaceita null
  País do endereço. Incluído quando o endereço é lido sozinho.
  Atributos aninhados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exatamente 2 caracteres
  createdAtstring <date-time>obrigatórioaceita null
  Quando o endereço foi salvo.
  updatedAtstring <date-time>obrigatórioaceita null
  Quando o endereço mudou pela última vez.
accountConta
A conta depois do crédito.
Atributos aninhados
- namestringobrigatório
  pelo menos 1 caracteres
- displayNamestringobrigatório
  pelo menos 1 caracteres
- systemUnitsstringobrigatório
  Valores permitidos:imperialmetric
- emailstringobrigatório
  pelo menos 1 caracteres
- notificationEmailstringobrigatório
  pelo menos 1 caracteres
- websitestringobrigatórioaceita null
- phonestringobrigatórioaceita null
  pelo menos 1 caracteres
- emergencyPhonestringobrigatórioaceita null
  pelo menos 1 caracteres
- taxIdstringaceita null
- taxIdCountryobjectaceita null
  Atributos aninhados
  isoCodestringobrigatório
- uidstringsomente leitura
- accountNumberstringsomente leitura
- parentUidstringaceita nullsomente leitura
  O uid da conta principal quando esta é uma subconta; null caso contrário.
- statusstringsomente leitura
- languagestringobrigatório
- isBusinessboolean | integerobrigatório
- allowBankAccountPaymentsboolean | integersomente leitura
- metadataobjectaceita nullsomente leitura
- createdAtstring <date-time>somente leitura
- updatedAtstring <date-time>somente leitura
- deletedAtstring <date-time>aceita nullsomente leitura
- addressIdnumberaceita nullsomente leitura
- billingAddressIdnumberaceita nullsomente leitura
- defaultShipFromIdnumberaceita nullsomente leitura
- defaultAddressOnLabelIdnumberaceita nullsomente leitura
- defaultReturnAddressIdnumberaceita nullsomente leitura
- primaryPaymentShipmentsIdnumberaceita nullsomente leitura
- logoIdnumberaceita nullsomente leitura
- pickupServiceFallbackIdnumberaceita nullsomente leitura
- revisionnumberaceita nullsomente leitura
- addressEndereço da conta | object
  Endereço principal da conta.
  Atributos aninhados
  Um de
  uidstringobrigatórioaceita null
  UID do endereço. Use-o como accountAddressId, ou como uid do remetente / destinatário em um envio.
  nicknamestringaceita null
  Nome exibido nos catálogos de endereços.
  namestringaceita null
  Nome do contato.
  companyNamestringaceita null
  Nome da empresa.
  taxIdstringaceita null
  Documento fiscal do contato.
  emailstringaceita null
  E-mail do contato.
  phonestringaceita null
  Telefone do contato, E.164.
  birthdaystring <date-time>aceita null
  Data de nascimento do contato, quando coletada.
  isRecipientboolean | integeraceita null
  O endereço pode receber envios. 1/true ou 0/false.
  isSenderboolean | integeraceita null
  O endereço pode enviar envios. 1/true ou 0/false.
  isResidentialboolean | integeraceita null
  O endereço é residencial. 1/true ou 0/false.
  statusstringobrigatórioaceita null
  Status do registro.
  addressobjectaceita null
  Endereço postal. Incluído quando o endereço é lido sozinho.
  Atributos aninhados
  cityobject
  Atributos aninhados
  namestringaceita null
  stateobject
  Atributos aninhados
  namestringaceita null
  streetstring
  Endereço, incluindo o número do prédio ou apartamento.
  postalCodestring
  countryobjectaceita null
  País do endereço. Incluído quando o endereço é lido sozinho.
  Atributos aninhados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exatamente 2 caracteres
  createdAtstring <date-time>obrigatórioaceita null
  Quando o endereço foi salvo.
  updatedAtstring <date-time>obrigatórioaceita null
  Quando o endereço mudou pela última vez.
transactionTransação
O crédito na carteira.
Atributos aninhados
- 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
transactionFeeTransação
A tarifa de processamento cobrada pelo pagamento, quando houver.
Atributos aninhados
- 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 Solicitação de fundos

{
  "result": {
    "account": {
      "name": "Acme Imports",
      "displayName": "Acme Imports",
      "systemUnits": "metric",
      "email": "jane.doe@example.com",
      "notificationEmail": "jane.doe@example.com",
      "website": null,
      "phone": null,
      "emergencyPhone": null,
      "taxId": null,
      "uid": "un0xo9497f7d",
      "accountNumber": "000ACC1X12",
      "status": "active",
      "language": "en",
      "isBusiness": false,
      "allowBankAccountPayments": false,
      "metadata": null,
      "createdAt": "2026-11-01T00:37:54.000Z",
      "updatedAt": "2026-11-01T00:37:54.000Z",
      "deletedAt": null,
      "addressId": null,
      "billingAddressId": null,
      "defaultShipFromId": null,
      "defaultAddressOnLabelId": null,
      "defaultReturnAddressId": null,
      "primaryPaymentShipmentsId": null,
      "logoId": null,
      "pickupServiceFallbackId": null,
      "revision": 1
    }
  },
  "transaction": {
    "id": 1,
    "uid": "f3g35lk6rf5vd7550fp31w3ua595nr2l4ce6",
    "type": "credit",
    "transType": "Payment",
    "state": "cleared",
    "referenceNo": "PNQB9YCJIUS",
    "description": "Payment from API (add credit) - crypto deposit",
    "amount": 30,
    "balance": 30,
    "accountId": 1,
    "createdAt": "2026-11-01T00:37:54.652Z",
    "updatedAt": "2026-11-01T00:37:54.652Z"
  }
}

Adicionar fundos à sua carteira

POST/add-funds

Requer um token de acesso

Adiciona dinheiro à sua carteira. Com zelle o pagamento é registrado e creditado quando a WeShipYou o confirma; com crypto a cobrança paga da Coinbase é creditada na hora.

Parâmetros de cabeçalho

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

Corpo da requisiçãoapplication/json

O envio a criar.

paymentMethodstring
Como você pagou: zelle (o padrão) ou crypto.
Valores permitidos:zellecrypto
Padrão: zelle
accountUidstring
O uid da conta. Opcional quando você faz parte de uma única conta.
transactionobject
Atributos aninhados
- zelleTransactionstring
  O ID da transação Zelle, para zelle.
- amountnumber
  Valor que você enviou, USD. Obrigatório para zelle e crypto.
- chargeUidstring
  O código da cobrança paga da Coinbase Commerce, para crypto.

Respostas

201

Operação bem-sucedida

O objeto Solicitação de fundos

400

Requisição inválida

namestring
Sempre BadRequest
messagestring
codenumber
Sempre 400
classNamestring
Sempre bad-request
dataobject

401

Token de acesso ausente ou inválido

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

404

O pagamento não foi encontrado

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

POST/add-funds

curl -X POST 'https://sandbox.weshipyou.com/api/v1/add-funds' \
  -H "Authorization: Bearer $WSY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "paymentMethod": "zelle",
  "accountUid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "transaction": {
    "zelleTransaction": "ZL-20261001-0001",
    "amount": 20
  }
}'

Resposta

{
  "result": {
    "account": {
      "name": "Acme Imports",
      "displayName": "Acme Imports",
      "systemUnits": "metric",
      "email": "jane.doe@example.com",
      "notificationEmail": "jane.doe@example.com",
      "website": null,
      "phone": null,
      "emergencyPhone": null,
      "taxId": null,
      "uid": "un0xo9497f7d",
      "accountNumber": "000ACC1X12",
      "status": "active",
      "language": "en",
      "isBusiness": false,
      "allowBankAccountPayments": false,
      "metadata": null,
      "createdAt": "2026-11-01T00:37:54.000Z",
      "updatedAt": "2026-11-01T00:37:54.000Z",
      "deletedAt": null,
      "addressId": null,
      "billingAddressId": null,
      "defaultShipFromId": null,
      "defaultAddressOnLabelId": null,
      "defaultReturnAddressId": null,
      "primaryPaymentShipmentsId": null,
      "logoId": null,
      "pickupServiceFallbackId": null,
      "revision": 1
    }
  },
  "transaction": {
    "id": 1,
    "uid": "f3g35lk6rf5vd7550fp31w3ua595nr2l4ce6",
    "type": "credit",
    "transType": "Payment",
    "state": "cleared",
    "referenceNo": "PNQB9YCJIUS",
    "description": "Payment from API (add credit) - crypto deposit",
    "amount": 30,
    "balance": 30,
    "accountId": 1,
    "createdAt": "2026-11-01T00:37:54.652Z",
    "updatedAt": "2026-11-01T00:37:54.652Z"
  }
}

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