Agregar fondos

Agrega dinero a tu billetera

POST/add-funds

El objeto Solicitud de fondos

El crédito que se registró en la billetera. Según el método de pago, la cuenta se devuelve en result.account o en account; una solicitud que solo registra un pago pendiente responde { "ok": true }.

Atributos

okboolean
El pago se registró y se acreditará cuando se confirme.
Siempre true
resultobject
Atributos anidados
- accountCuenta
  La cuenta después del crédito.
  Atributos anidados
  namestringobligatorio
  al menos 1 caracteres
  displayNamestringobligatorio
  al menos 1 caracteres
  systemUnitsstringobligatorio
  Valores permitidos:imperialmetric
  emailstringobligatorio
  al menos 1 caracteres
  notificationEmailstringobligatorio
  al menos 1 caracteres
  websitestringobligatorioadmite null
  phonestringobligatorioadmite null
  al menos 1 caracteres
  emergencyPhonestringobligatorioadmite null
  al menos 1 caracteres
  taxIdstringadmite null
  taxIdCountryobjectadmite null
  Atributos anidados
  isoCodestringobligatorio
  uidstringsolo lectura
  accountNumberstringsolo lectura
  parentUidstringadmite nullsolo lectura
  El uid de la cuenta principal cuando esta es una subcuenta; null en otro caso.
  statusstringsolo lectura
  languagestringobligatorio
  isBusinessboolean | integerobligatorio
  allowBankAccountPaymentsboolean | integersolo lectura
  metadataobjectadmite nullsolo lectura
  createdAtstring <date-time>solo lectura
  updatedAtstring <date-time>solo lectura
  deletedAtstring <date-time>admite nullsolo lectura
  addressIdnumberadmite nullsolo lectura
  billingAddressIdnumberadmite nullsolo lectura
  defaultShipFromIdnumberadmite nullsolo lectura
  defaultAddressOnLabelIdnumberadmite nullsolo lectura
  defaultReturnAddressIdnumberadmite nullsolo lectura
  primaryPaymentShipmentsIdnumberadmite nullsolo lectura
  logoIdnumberadmite nullsolo lectura
  pickupServiceFallbackIdnumberadmite nullsolo lectura
  revisionnumberadmite nullsolo lectura
  addressDirección de la cuenta | object
  Dirección principal de la cuenta.
  Atributos anidados
  Uno de
  uidstringobligatorioadmite null
  UID de la dirección. Úsalo como accountAddressId, o como uid del remitente / destinatario en un envío.
  nicknamestringadmite null
  Nombre que se muestra en las libretas de direcciones.
  namestringadmite null
  Nombre del contacto.
  companyNamestringadmite null
  Nombre de la empresa.
  taxIdstringadmite null
  Id fiscal del contacto.
  emailstringadmite null
  Correo del contacto.
  phonestringadmite null
  Teléfono del contacto, E.164.
  birthdaystring <date-time>admite null
  Fecha de nacimiento del contacto, cuando se recopila.
  isRecipientboolean | integeradmite null
  La dirección puede recibir envíos. 1/true o 0/false.
  isSenderboolean | integeradmite null
  La dirección puede enviar envíos. 1/true o 0/false.
  isResidentialboolean | integeradmite null
  La dirección es residencial. 1/true o 0/false.
  statusstringobligatorioadmite null
  Estado del registro.
  addressobjectadmite null
  Dirección postal. Se incluye cuando la dirección se lee sola.
  Atributos anidados
  cityobject
  Atributos anidados
  namestringadmite null
  stateobject
  Atributos anidados
  streetstring
  Dirección, incluido el número de edificio o apartamento.
  postalCodestring
  countryobjectadmite null
  País de la dirección. Se incluye cuando la dirección se lee sola.
  Atributos anidados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exactamente 2 caracteres
  createdAtstring <date-time>obligatorioadmite null
  Cuándo se guardó la dirección.
  updatedAtstring <date-time>obligatorioadmite null
  Cuándo cambió la dirección por última vez.
accountCuenta
La cuenta después del crédito.
Atributos anidados
- namestringobligatorio
  al menos 1 caracteres
- displayNamestringobligatorio
  al menos 1 caracteres
- systemUnitsstringobligatorio
  Valores permitidos:imperialmetric
- emailstringobligatorio
  al menos 1 caracteres
- notificationEmailstringobligatorio
  al menos 1 caracteres
- websitestringobligatorioadmite null
- phonestringobligatorioadmite null
  al menos 1 caracteres
- emergencyPhonestringobligatorioadmite null
  al menos 1 caracteres
- taxIdstringadmite null
- taxIdCountryobjectadmite null
  Atributos anidados
  isoCodestringobligatorio
- uidstringsolo lectura
- accountNumberstringsolo lectura
- parentUidstringadmite nullsolo lectura
  El uid de la cuenta principal cuando esta es una subcuenta; null en otro caso.
- statusstringsolo lectura
- languagestringobligatorio
- isBusinessboolean | integerobligatorio
- allowBankAccountPaymentsboolean | integersolo lectura
- metadataobjectadmite nullsolo lectura
- createdAtstring <date-time>solo lectura
- updatedAtstring <date-time>solo lectura
- deletedAtstring <date-time>admite nullsolo lectura
- addressIdnumberadmite nullsolo lectura
- billingAddressIdnumberadmite nullsolo lectura
- defaultShipFromIdnumberadmite nullsolo lectura
- defaultAddressOnLabelIdnumberadmite nullsolo lectura
- defaultReturnAddressIdnumberadmite nullsolo lectura
- primaryPaymentShipmentsIdnumberadmite nullsolo lectura
- logoIdnumberadmite nullsolo lectura
- pickupServiceFallbackIdnumberadmite nullsolo lectura
- revisionnumberadmite nullsolo lectura
- addressDirección de la cuenta | object
  Dirección principal de la cuenta.
  Atributos anidados
  Uno de
  uidstringobligatorioadmite null
  UID de la dirección. Úsalo como accountAddressId, o como uid del remitente / destinatario en un envío.
  nicknamestringadmite null
  Nombre que se muestra en las libretas de direcciones.
  namestringadmite null
  Nombre del contacto.
  companyNamestringadmite null
  Nombre de la empresa.
  taxIdstringadmite null
  Id fiscal del contacto.
  emailstringadmite null
  Correo del contacto.
  phonestringadmite null
  Teléfono del contacto, E.164.
  birthdaystring <date-time>admite null
  Fecha de nacimiento del contacto, cuando se recopila.
  isRecipientboolean | integeradmite null
  La dirección puede recibir envíos. 1/true o 0/false.
  isSenderboolean | integeradmite null
  La dirección puede enviar envíos. 1/true o 0/false.
  isResidentialboolean | integeradmite null
  La dirección es residencial. 1/true o 0/false.
  statusstringobligatorioadmite null
  Estado del registro.
  addressobjectadmite null
  Dirección postal. Se incluye cuando la dirección se lee sola.
  Atributos anidados
  cityobject
  Atributos anidados
  namestringadmite null
  stateobject
  Atributos anidados
  namestringadmite null
  streetstring
  Dirección, incluido el número de edificio o apartamento.
  postalCodestring
  countryobjectadmite null
  País de la dirección. Se incluye cuando la dirección se lee sola.
  Atributos anidados
  isoCodestring
  Valores permitidos:ADAEAFALAGAIAQAMAOARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRXKKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMHUMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSSSESGSHSISJSKSLSMSNSOSRSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYTYEZAZMZWCSAN
  exactamente 2 caracteres
  createdAtstring <date-time>obligatorioadmite null
  Cuándo se guardó la dirección.
  updatedAtstring <date-time>obligatorioadmite null
  Cuándo cambió la dirección por última vez.
transactionTransacción
El crédito en la billetera.
Atributos anidados
- idnumber <int64>solo lectura
  ID interno de la transacción.
- uidstringsolo lectura
  UID de la transacción.
- typestring
  credit (entrada de dinero) o debit (salida de dinero).
  Valores permitidos:debitcreditrefund
  al menos 1 caracteres
- transTypestring
  Para qué es la transacción, por ejemplo Payment, Shipment o Recharge.
  Valores permitidos:ShipmentPaymentMoney TransferAdjustmenFee
  al menos 1 caracteres
- statestring
  Estado de liquidación, por ejemplo cleared o pending.
  Valores permitidos:clearedpending
  al menos 1 caracteres
- referenceNostring
  Número de referencia del pago o del servicio.
  al menos 1 caracteres
- descriptionstring
  Descripción de la transacción.
  al menos 1 caracteres
- courierNamestringadmite null
  Transportista del envío, en los cobros de envíos.
  al menos 1 caracteres
- amountnumber
  Monto, USD.
  al menos 1 caracteres
- balancenumber
  Saldo de la billetera después de esta transacción, USD.
  al menos 1 caracteres
- accountIdnumber
  ID interno de la cuenta a la que pertenece la transacción.
  al menos 1 caracteres
- adjustmentTypeIdnumberadmite null
  ID interno del ajuste, en los ajustes manuales.
  al menos 1 caracteres
- createdAtstring <date-time>
  Cuándo se registró la transacción.
  al menos 1 caracteres
- updatedAtstring <date-time>
  Cuándo cambió la transacción por última vez.
  al menos 1 caracteres
transactionFeeTransacción
La comisión de procesamiento cobrada por el pago, cuando la hay.
Atributos anidados
- idnumber <int64>solo lectura
  ID interno de la transacción.
- uidstringsolo lectura
  UID de la transacción.
- typestring
  credit (entrada de dinero) o debit (salida de dinero).
  Valores permitidos:debitcreditrefund
  al menos 1 caracteres
- transTypestring
  Para qué es la transacción, por ejemplo Payment, Shipment o Recharge.
  Valores permitidos:ShipmentPaymentMoney TransferAdjustmenFee
  al menos 1 caracteres
- statestring
  Estado de liquidación, por ejemplo cleared o pending.
  Valores permitidos:clearedpending
  al menos 1 caracteres
- referenceNostring
  Número de referencia del pago o del servicio.
  al menos 1 caracteres
- descriptionstring
  Descripción de la transacción.
  al menos 1 caracteres
- courierNamestringadmite null
  Transportista del envío, en los cobros de envíos.
  al menos 1 caracteres
- amountnumber
  Monto, USD.
  al menos 1 caracteres
- balancenumber
  Saldo de la billetera después de esta transacción, USD.
  al menos 1 caracteres
- accountIdnumber
  ID interno de la cuenta a la que pertenece la transacción.
  al menos 1 caracteres
- adjustmentTypeIdnumberadmite null
  ID interno del ajuste, en los ajustes manuales.
  al menos 1 caracteres
- createdAtstring <date-time>
  Cuándo se registró la transacción.
  al menos 1 caracteres
- updatedAtstring <date-time>
  Cuándo cambió la transacción por última vez.
  al menos 1 caracteres

El objeto Solicitud de fondos

{
  "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"
  }
}

Agregar fondos a tu billetera

POST/add-funds

Requiere un token de acceso

Agrega dinero a tu billetera. Con zelle el pago se registra y se acredita cuando WeShipYou lo confirma; con crypto el cargo pagado de Coinbase se acredita de inmediato.

Parámetros de cabecera

Accept-Languagestring
Código de dos letras del idioma de los mensajes: en, es o pt.
Por defecto: en-US

Cuerpo de la solicitudapplication/json

El envío que se va a crear.

paymentMethodstring
Cómo pagaste: zelle (por defecto) o crypto.
Valores permitidos:zellecrypto
Por defecto: zelle
accountUidstring
El uid de la cuenta. Opcional cuando perteneces a una sola cuenta.
transactionobject
Atributos anidados
- zelleTransactionstring
  El ID de la transacción de Zelle, para zelle.
- amountnumber
  Monto que enviaste, USD. Obligatorio para zelle y crypto.
- chargeUidstring
  El código del cargo pagado de Coinbase Commerce, para crypto.

Respuestas

201

Operación exitosa

El objeto Solicitud de fondos

400

Solicitud no válida

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

401

Token de acceso ausente o no válido

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

404

No se encontró el pago

namestring
Siempre NotFound
messagestring
codenumber
Siempre 404
classNamestring
Siempre 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
  }
}'

Respuesta

{
  "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"
  }
}

PruébaloEnvía una solicitud real al entorno Prueba desde esta página, sin escribir código.