WalletSubAccount

Companies that support Multi-Wallet setup can create WalletSubAccounts

A WalletSubAccount can be created without a credit card, its wallet balance can be deducted without a card on file and the organization can credit its first refill, see Refill WalletSubAccount. Once a card is added the WalletSubAccount gets its own Stripe customer, the wallet refills of the subaccount are charged from its default card. Every WalletSubAccount also gets its own token, it can be handed to the client the subaccount represents. The subaccount token can only read and update its own WalletSubAccount and manage its credit cards, all other endpoints return 403 or 404.

List WalletSubAccounts

GET /orgs/{org_pk}/wallet-subaccounts/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

Response 200 (application/json):

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "url": "/api/v2/orgs/1/wallet-subaccounts/1/",
      "unique_id": "acme",
      "bill_to": {
        "company": "ABC Inc.",
        "first_name": "John",
        "last_name": "Doe",
        "address_1": "123 Main St",
        "address_2": "",
        "city": "New York",
        "state": "NY",
        "post_code": "10001",
        "country": "USA",
        "phone": "555-555-5555",
        "email": "[email protected]",
        "residential": false,
        "validated": false,
        "updated_at": "2024-03-10T16:19:25Z",
        "created_at": "2024-03-10T16:19:25Z"
      },
      "ship_to": {
        "company": "XYZ Corp.",
        "first_name": "Jane",
        "last_name": "Smith",
        "address_1": "456 Elm St",
        "address_2": "Apt 2",
        "city": "Los Angeles",
        "state": "CA",
        "post_code": "90001",
        "country": "USA",
        "phone": "555-123-4567",
        "email": "[email protected]",
        "residential": true,
        "validated": true,
        "updated_at": "2024-03-10T16:19:25Z",
        "created_at": "2024-03-10T16:19:25Z"
      },
      "name": "Acme Inc.",
      "email": null,
      "token": "e18a6d4a7627e462d64fd30a7d1ea160",
      "refresh_token": "f3b893ecf1da71c5359b4322ac8baac9",
      "token_expires_at": "1710085765",
      "stripe_client_id": "cus_PmXr0yT6Jbq7Dk",
      "stripe_credit_card": "card_1OxYz2LkdIwHu7ix",
      "wallet_auto_refill_limit": "10.00 USD",
      "wallet_auto_refill_amount": "20.00 USD",
      "negative_balance_reached_at": null,
      "suspended_at": "2024-03-10T16:19:25Z",
      "updated_at": "2024-03-10T16:19:25Z",
      "created_at": "2024-03-10T16:19:25Z"
    },
    {
      "url": "/api/v2/orgs/ORG/wallet-subaccounts/2/",
      "unique_id": "pear",
      "bill_to": {
        "company": "Smith & Sons",
        "first_name": "Michael",
        "last_name": "Smith",
        "address_1": "789 Oak Ave",
        "address_2": "Suite 100",
        "city": "Chicago",
        "state": "IL",
        "post_code": "60601",
        "country": "USA",
        "phone": "555-789-1234",
        "email": "[email protected]",
        "residential": false,
        "validated": true,
        "updated_at": "2024-03-10T16:19:25Z",
        "created_at": "2024-03-10T16:19:25Z"
      },
      "ship_to": {
        "company": "Johnson Co.",
        "first_name": "Emily",
        "last_name": "Johnson",
        "address_1": "101 Pine St",
        "address_2": "",
        "city": "Miami",
        "state": "FL",
        "post_code": "33101",
        "country": "USA",
        "phone": "555-987-6543",
        "email": "[email protected]",
        "residential": true,
        "validated": true,
        "updated_at": "2024-03-10T16:19:25Z",
        "created_at": "2024-03-10T16:19:25Z"
      },
      "name": "Pear Inc.",
      "email": null,
      "token": "25ef6e6b686fb5d39ca44fb4832be924",
      "refresh_token": "d1f064564fff0def91246c9b57697d35",
      "token_expires_at": "1710085765",
      "stripe_client_id": "cus_PmXs4hQ9Lc2Wvn",
      "stripe_credit_card": "card_1OxYzQLkdIwHu7aB",
      "wallet_auto_refill_limit": "30.00 USD",
      "wallet_auto_refill_amount": "15.00 USD",
      "negative_balance_reached_at": "2024-03-10T16:19:25Z",
      "suspended_at": null,
      "updated_at": "2024-03-10T16:19:25Z",
      "created_at": "2024-03-10T16:19:25Z"
    }
  ]
}

Get WalletSubAccount

GET /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

Response 200 (application/json):

{
  "url": "/api/v2/orgs/1/wallet-subaccounts/1/",
  "unique_id": "acme",
  "bill_to": {
    "company": "ABC Inc.",
    "first_name": "John",
    "last_name": "Doe",
    "address_1": "123 Main St",
    "address_2": "",
    "city": "New York",
    "state": "NY",
    "post_code": "10001",
    "country": "USA",
    "phone": "555-555-5555",
    "email": "[email protected]",
    "residential": false,
    "validated": false,
    "updated_at": "2024-03-10T16:19:25Z",
    "created_at": "2024-03-10T16:19:25Z"
  },
  "ship_to": {
    "company": "XYZ Corp.",
    "first_name": "Jane",
    "last_name": "Smith",
    "address_1": "456 Elm St",
    "address_2": "Apt 2",
    "city": "Los Angeles",
    "state": "CA",
    "post_code": "90001",
    "country": "USA",
    "phone": "555-123-4567",
    "email": "[email protected]",
    "residential": true,
    "validated": true,
    "updated_at": "2024-03-10T16:19:25Z",
    "created_at": "2024-03-10T16:19:25Z"
  },
  "name": "Acme Inc.",
  "email": null,
  "token": "e18a6d4a7627e462d64fd30a7d1ea160",
  "refresh_token": "f3b893ecf1da71c5359b4322ac8baac9",
  "token_expires_at": "1710085765",
  "stripe_client_id": "cus_PmXr0yT6Jbq7Dk",
  "stripe_credit_card": "card_1OxYz2LkdIwHu7ix",
  "wallet_auto_refill_limit": "10.00 USD",
  "wallet_auto_refill_amount": "20.00 USD",
  "negative_balance_reached_at": null,
  "suspended_at": "2024-03-10T16:19:25Z",
  "updated_at": "2024-03-10T16:19:25Z",
  "created_at": "2024-03-10T16:19:25Z"
}

Create WalletSubAccount

Create new WalletSubAccount, no credit card is required, see Add the first credit card. Note that 400 response will be returned if WalletSubAccount with supplied unique_id already exists.

POST /orgs/{org_pk}/wallet-subaccounts/

  • Attributes:
    • unique_id (required) - unique identifier of the customer.
    • name - customer’s name
    • email - customer’s email, receives refill receipts and negative balance notifications
    • bill_to - customer’s billing address
    • ship_to - customer’s shipping address
    • wallet_auto_refill_limit - balance threshold that triggers the automatic refill
    • wallet_auto_refill_amount - amount of the automatic refill

stripe_client_id and stripe_credit_card are read-only, they are set by ReadyCloud when the first credit card is added and are null until then.

Example request:

curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

data.json:

{
  "unique_id": "orange",
  "bill_to": {
    "company": "Orange Co.",
    "first_name": "Alice",
    "last_name": "Johnson",
    "address_1": "789 Maple Ave",
    "address_2": "Apt 200",
    "city": "Boston",
    "state": "MA",
    "post_code": "02101",
    "country": "USA",
    "phone": "555-123-4567",
    "email": "[email protected]",
    "residential": true,
    "validated": false
  },
  "ship_to": {
    "company": "Green Corp.",
    "first_name": "Bob",
    "last_name": "Smith",
    "address_1": "456 Pine St",
    "address_2": "Suite 50",
    "city": "Seattle",
    "state": "WA",
    "post_code": "98101",
    "country": "USA",
    "phone": "555-987-6543",
    "email": "[email protected]",
    "residential": false,
    "validated": true
  },
  "name": "Orange Inc.",
  "email": "[email protected]",
  "wallet_auto_refill_limit": "50.00 USD",
  "wallet_auto_refill_amount": "25.00 USD"
}

Response 201 (application/json):

{
  "unique_id": "orange",
  "bill_to": {
    "company": "Orange Co.",
    "first_name": "Alice",
    "last_name": "Johnson",
    "address_1": "789 Maple Ave",
    "address_2": "Apt 200",
    "city": "Boston",
    "state": "MA",
    "post_code": "02101",
    "country": "USA",
    "phone": "555-123-4567",
    "email": "[email protected]",
    "residential": true,
    "validated": false
  },
  "ship_to": {
    "company": "Green Corp.",
    "first_name": "Bob",
    "last_name": "Smith",
    "address_1": "456 Pine St",
    "address_2": "Suite 50",
    "city": "Seattle",
    "state": "WA",
    "post_code": "98101",
    "country": "USA",
    "phone": "555-987-6543",
    "email": "[email protected]",
    "residential": false,
    "validated": true
  },
  "name": "Orange Inc.",
  "email": "[email protected]",
  "token": "e18a6d4a7627e462d64fd30a7d1ea160",
  "refresh_token": "f3b893ecf1da71c5359b4322ac8baac9",
  "token_expires_at": "1710085765",
  "stripe_client_id": null,
  "stripe_credit_card": null,
  "wallet_auto_refill_limit": "50.00 USD",
  "wallet_auto_refill_amount": "25.00 USD",
  "negative_balance_reached_at": null
}

Note that token is assigned upon the WalletSubAccount creation. Token will be valid for 30 minutes, after that you need to refer to the Refresh WalletSubAccount token section.

Update WalletSubAccount

Update specific WalletSubAccount, both the organization token and the subaccount token can be used. unique_id, token, refresh_token, token_expires_at, stripe_client_id, stripe_credit_card, negative_balance_reached_at and suspended_at are read-only.

PATCH /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/

Example request:

curl -iL --request PATCH -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

data.json:

{
  "name": "Acme Corp.",
  "email": "[email protected]",
  "wallet_auto_refill_limit": "15.00 USD"
}

Response 200 (application/json):

{
  "url": "/api/v2/orgs/1/wallet-subaccounts/1/",
  "unique_id": "acme",
  "bill_to": {
    "company": "ABC Inc.",
    "first_name": "John",
    "last_name": "Doe",
    "address_1": "123 Main St",
    "address_2": "",
    "city": "New York",
    "state": "NY",
    "post_code": "10001",
    "country": "USA",
    "phone": "555-555-5555",
    "email": "[email protected]",
    "residential": false,
    "validated": false,
    "updated_at": "2024-03-10T16:19:25Z",
    "created_at": "2024-03-10T16:19:25Z"
  },
  "ship_to": {
    "company": "XYZ Corp.",
    "first_name": "Jane",
    "last_name": "Smith",
    "address_1": "456 Elm St",
    "address_2": "Apt 2",
    "city": "Los Angeles",
    "state": "CA",
    "post_code": "90001",
    "country": "USA",
    "phone": "555-123-4567",
    "email": "[email protected]",
    "residential": true,
    "validated": true,
    "updated_at": "2024-03-10T16:19:25Z",
    "created_at": "2024-03-10T16:19:25Z"
  },
  "name": "Acme Corp.",
  "email": "[email protected]",
  "token": "e18a6d4a7627e462d64fd30a7d1ea160",
  "refresh_token": "f3b893ecf1da71c5359b4322ac8baac9",
  "token_expires_at": "1710085765",
  "stripe_client_id": "cus_PmXr0yT6Jbq7Dk",
  "stripe_credit_card": "card_1OxYz2LkdIwHu7ix",
  "wallet_auto_refill_limit": "15.00 USD",
  "wallet_auto_refill_amount": "20.00 USD",
  "negative_balance_reached_at": null,
  "suspended_at": null,
  "updated_at": "2024-03-10T16:19:25Z",
  "created_at": "2024-03-10T16:19:25Z"
}

Add the first WalletSubAccount credit card

Send stripe_token with the Update WalletSubAccount request to create the Stripe customer of the WalletSubAccount, the card becomes its default card. Both the organization token and the subaccount token can be used, other WalletSubAccount fields can be updated by the same request.

PATCH /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/

  • Attributes:
    • stripe_token (required) - card token created in the browser by Stripe.js with ReadyCloud’s publishable key.

stripe_token can be sent only once, 400 response is returned under stripe_token if the WalletSubAccount already has a Stripe customer, use the WalletSubAccount credit cards endpoints to add or change cards after that. 400 response is also returned under stripe_token if the card is declined or the token is invalid, the WalletSubAccount is not updated in that case.

Example request:

curl -iL --request PATCH -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/?bearer_token=e18a6d4a7627e462d64fd30a7d1ea160"

data.json:

{
  "stripe_token": "tok_1OxYz1LkdIwHu7ixq9Xb2Kc8"
}

Response 200 (application/json):

The updated WalletSubAccount, same as in Get WalletSubAccount, with stripe_client_id and stripe_credit_card set.

Refresh WalletSubAccount token

Refresh token to get access for additional 30 minutes. refresh_token is taken from refresh_token of respective WalletSubAccount API instance, it’s the only credential needed, client_id and client_secret are not required. The body must be form-encoded and only grant_type=refresh_token is accepted. Every refresh issues a new refresh_token and the old one stops working, store the new one from each response.

POST /api/v1/oauth2/subaccount-token/

Example request:

curl -iL --request POST "https://www.readycloud.com/api/v1/oauth2/subaccount-token/" -d "grant_type=refresh_token" -d "refresh_token=f3b893ecf1da71c5359b4322ac8baac9"

Response 200 (application/json):

{
  "access_token": "e18a6d4a7627e462d64fd30a7d1ea160",
  "expires_in": 1800,
  "token_type": "bearer",
  "refresh_token": "f9956dbda773b3d88ad07c41e66f7b5f",
  "scope": "wallet_subaccount"
}

List WalletSubAccount credit cards

Credit cards of the WalletSubAccount’s Stripe customer, both the organization token and the subaccount token can be used. 404 response is returned if the WalletSubAccount has no credit card yet. The card with default set to true is the one charged by the wallet refills of the subaccount.

GET /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/credit-cards/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/?bearer_token=e18a6d4a7627e462d64fd30a7d1ea160"

Response 200 (application/json):

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "card_1OxYz2LkdIwHu7ix",
      "brand": "Visa",
      "last4": "4242",
      "name": "Jane Doe",
      "exp_month": "12",
      "exp_year": "2030",
      "address_zip": "10001",
      "default": true,
      "address_city": "New York",
      "address_country": "US",
      "address_line1": "1 Main St",
      "address_line2": null,
      "address_state": "NY",
      "phone": null,
      "email": null,
      "url": "/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/card_1OxYz2LkdIwHu7ix/"
    },
    {
      "id": "card_1OxZ0aLkdIwHu7Qd",
      "brand": "MasterCard",
      "last4": "4444",
      "name": "Jane Doe",
      "exp_month": "6",
      "exp_year": "2028",
      "address_zip": "10001",
      "default": false,
      "address_city": "New York",
      "address_country": "US",
      "address_line1": "1 Main St",
      "address_line2": null,
      "address_state": "NY",
      "phone": null,
      "email": null,
      "url": "/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/card_1OxZ0aLkdIwHu7Qd/"
    }
  ]
}

Add WalletSubAccount credit card

Add a new card to the WalletSubAccount’s Stripe customer. Card details never reach ReadyCloud, the card is tokenized in the browser by Stripe.js with ReadyCloud’s publishable key.

POST /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/credit-cards/

The first card can also be added here, it creates the Stripe customer of the WalletSubAccount like the Add the first credit card request.

  • Attributes:
    • stripe_token (required) - card token created by Stripe.js.
    • default - true makes the new card the one charged by the wallet refills, the first card of the subaccount is always made default.

400 response is returned under stripe_token if the card is declined or the token is invalid.

Example request:

curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/?bearer_token=e18a6d4a7627e462d64fd30a7d1ea160"

data.json:

{
  "stripe_token": "tok_1OxZ0ZLkdIwHu7ixR3mT8yLp",
  "default": false
}

Response 201 (application/json):

{
  "id": "card_1OxZ0aLkdIwHu7Qd",
  "brand": "MasterCard",
  "last4": "4444",
  "name": "Jane Doe",
  "exp_month": "6",
  "exp_year": "2028",
  "address_zip": "10001",
  "default": false,
  "address_city": "New York",
  "address_country": "US",
  "address_line1": "1 Main St",
  "address_line2": null,
  "address_state": "NY",
  "phone": null,
  "email": null,
  "url": "/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/card_1OxZ0aLkdIwHu7Qd/"
}

Get WalletSubAccount credit card

GET /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/credit-cards/{card_id}/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/card_1OxYz2LkdIwHu7ix/?bearer_token=e18a6d4a7627e462d64fd30a7d1ea160"

Response 200 (application/json):

{
  "id": "card_1OxYz2LkdIwHu7ix",
  "brand": "Visa",
  "last4": "4242",
  "name": "Jane Doe",
  "exp_month": "12",
  "exp_year": "2030",
  "address_zip": "10001",
  "default": true,
  "address_city": "New York",
  "address_country": "US",
  "address_line1": "1 Main St",
  "address_line2": null,
  "address_state": "NY",
  "phone": null,
  "email": null,
  "url": "/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/card_1OxYz2LkdIwHu7ix/"
}

Update WalletSubAccount credit card

Update the card’s holder name, expiration date and address, or make it the default card with "default": true. The card number can’t be changed, add a new card instead.

PATCH /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/credit-cards/{card_id}/

  • Attributes:
    • name, exp_month, exp_year, address_line1, address_line2, address_city, address_state, address_zip, address_country
    • default - true makes the card the one charged by the wallet refills.

Example request:

curl -iL --request PATCH -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/card_1OxZ0aLkdIwHu7Qd/?bearer_token=e18a6d4a7627e462d64fd30a7d1ea160"

data.json:

{
  "name": "John Doe",
  "exp_month": "01",
  "exp_year": "2031",
  "default": true
}

Response 200 (application/json):

{
  "id": "card_1OxZ0aLkdIwHu7Qd",
  "brand": "MasterCard",
  "last4": "4444",
  "name": "John Doe",
  "exp_month": "1",
  "exp_year": "2031",
  "address_zip": "10001",
  "default": true,
  "address_city": "New York",
  "address_country": "US",
  "address_line1": "1 Main St",
  "address_line2": null,
  "address_state": "NY",
  "phone": null,
  "email": null,
  "url": "/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/card_1OxZ0aLkdIwHu7Qd/"
}

Delete WalletSubAccount credit card

Remove the card from the WalletSubAccount’s Stripe customer. If the default card is removed, another card of the subaccount becomes the default one. The last card can’t be removed, 400 response is returned, add another card first.

DELETE /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/credit-cards/{card_id}/

Example request:

curl -iL --request DELETE "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/credit-cards/card_1OxZ0aLkdIwHu7Qd/?bearer_token=e18a6d4a7627e462d64fd30a7d1ea160"

Response 204

Refill WalletSubAccount

Add funds to the wallet balance of the WalletSubAccount, only the organization token can be used.

POST /orgs/{org_pk}/wallet-subaccount-transactions/

  • Attributes:
    • subaccount (required) - URL of the WalletSubAccount.
    • transaction_type (required) - refill.
    • kind (required) - kind of the transaction, e.g. action_alert.
    • amount (required) - positive amount to add to the balance.

The default card of the WalletSubAccount is charged for the amount. The first refill of a WalletSubAccount without a credit card is credited without a charge, e.g. when the organization bills its client outside ReadyCloud. It’s allowed only when the WalletSubAccount has no transactions yet, later refills require a credit card, see Add the first credit card. shipping, return and pickup charges of a WalletSubAccount without transactions create a 0.00 refill first, the organization can’t credit the WalletSubAccount after that. The minimum refill amount, the trial check and the receipt email apply only to refills charged to the card.

400 response with {"detail": "You need to add a credit card."} is returned if the WalletSubAccount has no credit card and it’s not its first refill, or with {"detail": "Your card could not be charged."} if the card is declined.

Example request:

curl -iL --request POST -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccount-transactions/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

data.json:

{
  "subaccount": "/api/v2/orgs/1/wallet-subaccounts/1/",
  "kind": "action_alert",
  "transaction_type": "refill",
  "amount": "30.00 USD"
}

Response 201 (application/json):

{
  "url": "/api/v2/orgs/1/wallet-subaccount-transactions/1/",
  "subaccount": "/api/v2/orgs/1/wallet-subaccounts/1/",
  "kind": "action_alert",
  "amount": "30.00 USD",
  "balance": "30.00 USD",
  "transaction_type": "refill",
  "created_at": "2024-03-10T16:19:25Z",
  "last_transaction": null,
  "log": null,
  "order": null,
  "order_primary_id": null,
  "box": null,
  "confirm_of": null,
  "void_of": null,
  "voided_by": null,
  "confirmed_by": null
}

List WalletSubAccountTransactions

GET /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/transactions/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/transactions/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

Response 200 (application/json):

{
  "count": 2,
  "next": null,
  "previous": null,
  "current_wallet_balance": "9963.00 USD",
  "results": [
    {
      "url": "/api/v2/orgs/1/wallet-subaccounts/1/transactions/1/",
      "kind": "equipment_return",
      "amount": "9999.00 USD",
      "balance": "9999.00 USD",
      "transaction_type": "refill",
      "created_at": "2017-11-09T11:19:46Z",
      "last_transaction": null,
      "log": null,
      "order": null,
      "order_primary_id": null,
      "box": null,
      "confirm_of": null,
      "void_of": null,
      "voided_by": null,
      "confirmed_by": null
    },
    {
      "url": "/api/v2/orgs/1/wallet-subaccounts/1/transactions/2/",
      "kind": "equipment_return",
      "amount": "-36.00 USD",
      "balance": "9963.00 USD",
      "transaction_type": "charge",
      "created_at": "2017-11-09T11:19:46Z",
      "last_transaction": "/api/v2/orgs/1/wallet-subaccounts/1/transactions/1/",
      "log": null,
      "order": "/api/v2/orgs/1/orders/1/",
      "order_primary_id": "AB-1001-R1",
      "box": "/api/v2/orgs/1/orders/1/boxes/1/",
      "confirm_of": null,
      "void_of": null,
      "voided_by": null,
      "confirmed_by": null
    }
  ]
}
  • filters: GET parameters to filter results.

    Filters will limit the WalletSubAccountTransactions returned, all filters are optional, multiple filters can be specified.

    • created_at__date - 2021-09-19

      Example. Get all transactions that were created in the given date in ISO 8601 format.

Get WalletSubAccountTransaction

GET /orgs/{org_pk}/wallet-subaccounts/{subaccount_pk}/transactions/{transaction_pk}/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/1/wallet-subaccounts/1/transactions/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

Response 200 (application/json):

{
  "url": "/api/v2/orgs/1/wallet-subaccounts/1/transactions/1/",
  "kind": "equipment_return",
  "amount": "9999.00 USD",
  "balance": "9999.00 USD",
  "transaction_type": "refill",
  "created_at": "2017-11-09T11:19:46Z",
  "last_transaction": null,
  "log": null,
  "order": null,
  "order_primary_id": null,
  "box": null,
  "confirm_of": null,
  "void_of": null,
  "voided_by": null,
  "confirmed_by": null
}