BYbyaccrue
Wallets

Create One-Time Deposit

Create a one-time deposit transaction for a wallet using an existing linked account.

Merchants can optionally include a disbursement array to split a portion of the total deposit among one or more counterparties. Any undisbursed amount is credited to the consumer's wallet.

Processing fees reported in charges.fee are collected from the counterparty configured as the Default for Fees on your merchant account.

Example: A consumer deposits $13.00 (1300 cents) with a $3.00 (300 cents) disbursement to counterparty A. Counterparty A receives $3.00 and the consumer's wallet is credited the remaining $10.00 (1000 cents).

post/api/v1/wallets/:walletId/transactions

Request

Path parameters

walletIdstring uuid required

The wallet ID to deposit to.

Example:123e4567-e89b-12d3-a456-426614174000

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Request body

Example request

{
  "data": {
    "attributes": {
      "amount": 1000,
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "linkedAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "disbursement": [
        {
          "amount": 300,
          "counterpartyId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ]
    }
  }
}

Response

201 Created

Example response

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transactionId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "Pending",
      "amount": 1300,
      "disbursement": [
        {
          "counterpartyId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "amount": 300,
          "fee": 0,
          "remit": true
        }
      ],
      "charges": {
        "fee": {
          "amount": 150,
          "type": "ACHFee"
        }
      },
      "deductions": {
        "fee": 150
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.