Get all withdrawals [DEPRECATED: Use transaction routes]

GET /api/v1/plans/{plan_uuid}/withdrawals/{subAccount}

Headers

Authorization string
Content-Type string
Accept string

Path parameters

plan_uuid string Required
subAccount integer Required

An optional sub-account to constrain the results by.

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
sort string

Field to sort by. Valid fields are [created_at, updated_at, withdrawn_at]. Negative sign to denote DESC. Defaults to '-withdrawn_at'.
per_page integer

Number of results to return with pagination (Default 15. Max 500).

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Additional properties are allowed.

GET /api/v1/plans/{plan_uuid}/withdrawals/{subAccount}

curl \
 -X GET https://api.plannrcrm.com/api/v1/plans/plan_uuid/withdrawals/subAccount \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"

Response examples (200)

{
  "data": [
    {
      "uuid": "d6c9f90d-cfb5-4dc1-8b74-5126f33b687c",
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        }
      },
      "created_at": "2024-11-20T13:24:03+00:00",
      "updated_at": "2024-11-20T13:24:03+00:00",
      "withdrawn_at": "2024-11-20T13:24:03+00:00"
    }
  ]
}