VEvelopaymentsapi
Funding

Get Funding

Changed on

Get Funding by Id

get/v1/fundings/{fundingId}

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

Path parameters

fundingIdstring uuid required

Response

Funding response

fundingIdstring uuid required
payorIdstring uuid required
createdAtstring date-time required

The date and time the funding was created

detectedFundingRefstring
amountinteger required
currencystring required

Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.

textstring
physicalAccountNamestring
sourceAccountIdstring uuid
allocationTypestring

Funding Allocation Type. One of the following values: AUTOMATIC, MANUAL

allocatedAtstring date-time

Populated only if the funding has been allocated. The date and time the funding was allocated.

allocationDatestring date-time

Populated with allocatedAt if allocated otherwise createdAt. Deprecated in v2.36 - will be removed in the future.

reasonstring
hiddenDatestring date-time
fundingAccountTypestring required

Funding Account Type. One of the following values: FBO, PRIVATE

statusstring required

Current status of the funding. One of the follwing values: PENDING, UNALLOCATED, ALLOCATED, HIDDEN, RETURNED, RETURNING, BULK_RETURN, OTHER

Example response

{
  "physicalAccountName": "physicalAccountName",
  "allocationDate": "2000-01-23T04:56:07.000+00:00",
  "reason": "reason",
  "amount": 0,
  "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "fundingId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "fundingAccountType": "FBO",
  "detectedFundingRef": "detectedFundingRef",
  "allocationType": "allocationType",
  "hiddenDate": "2000-01-23T04:56:07.000+00:00",
  "createdAt": "2000-01-23T04:56:07.000+00:00",
  "currency": "USD",
  "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "text": "text",
  "allocatedAt": "2000-01-23T04:56:07.000+00:00",
  "status": "ALLOCATED"
}

Changes

  • b924ba134e09Revision changes
    • breaking

      the response property became optional for the status

    • info

      added the optional property to the response with the status

    • info

      response property allocationDate deprecated

    • info

      added the required property to the response with the status

  • 27443d5dc998Revision changes
    • info

      api tag Funding added

    • info

      api tag Funding Manager removed