PApaypal
Wallets

Create Wallet transaction

post/wallets/{wallet_id}/wallet-transactions

Request

Path parameters

wallet_idstring required

Wallet ID

Request body

type'TOPUP' | 'VOID' required

Type of the wallet transaction applied on the wallet. Supported types are TOPUP, VOID.

paid_creditsstring

Number of paid credits to be added. Applicable only to TOPUP type of transaction

credits_to_voidstring

Number of credits and Only for type VOID, this field need to be passed in request.

granted_creditsstring

Number of granted credits to be added. Applicable only to TOPUP type of transaction

Example request

{
  "type": "TOPUP",
  "paid_credits": "20.0",
  "credits_to_void": "20.0",
  "granted_credits": "10.0",
  "metadata": [
    {
      "key": "reason",
      "value": "balance depleted"
    }
  ]
}

Response

Wallet transactions created successfully

Example response

{
  "wallet_transactions": [
    {
      "wallet_transaction_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "wallet_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "payment_status": "SETTLED",
      "source": "MANUAL",
      "transaction_status": "PURCHASED",
      "transaction_type": "INBOUND",
      "amount": {
        "value": 120.35,
        "currency_code": "USD"
      },
      "credits": "100.0",
      "settled_at": "2023-10-01T12:00:00Z",
      "failed_at": "2023-10-01T12:00:00Z",
      "created_at": "2023-10-01T12:00:00Z",
      "metadata": [
        {
          "key": "reason",
          "value": "balance depleted"
        }
      ]
    }
  ],
  "meta": {
    "next_page": 3,
    "prev_page": 1
  }
}

Changes

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