Sign in
Funding Events

Search funding events payments.

All the payments that made up the funding event

get/v1/funding_event_payments/{id}

Path parameters

idstring uuid required

Query parameters

page_numberinteger

Results page number. Starts at page 1. Default value: 1

Results page number. Starts at page 1. Default value: 1

page_sizeinteger

Results page size. Default value: 100. Max value: 1000

Results page size. Default value: 100. Max value: 1000

include_metadataboolean

Include the metadata for payments in the returned data.

Include the metadata for payments in the returned data.

default_page_sizeinteger
default_sort'created_at' | 'payment_date' | 'effective_at' | 'id'
default_sort_order'asc' | 'desc'
sort_by'created_at' | 'payment_date' | 'effective_at' | 'id'
sort_order'asc' | 'desc'

Headers

Straddle-Account-Idstring uuid

For use by platforms to specify an account id and set scope of a request.

Request-Idstring

Optional client generated identifier to trace and debug a request.

Correlation-Idstring

Optional client generated identifier to trace and debug a series of requests.

Response

OK

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.

Example response

{
  "data": [
    {
      "customer_details": {
        "name": "Ron Swanson",
        "email": "ron@swanson.com",
        "phone": "+1234567890"
      },
      "paykey_details": {
        "label": "Bank of America ****1234"
      }
    }
  ]
}

Changes

Changed in 11 of the 33 revisions of this API.56