Exports

Export Receivers

Exports a CSV file of receivers.

get/exports/receivers

Query parameters

qstring

A search term used to query through the receiver phone_number, email, and ID.

status'DRAFT' | 'READY' | 'REGISTERED' | 'FLAGGED'

Exact match on the status of the receiver wallet.

created_at_afterstring

Only return receivers that are created after this date. Format: YYYY-MM-DD

created_at_beforestring

Only return receivers that are created before this date. Format: YYYY-MM-DD

sort'updated_at' | 'created_at'

Field used to sort receivers

direction'asc' | 'desc'

Direction for sorting receivers.

Response

CSV file of receivers

Changes

Changed in 2 of the 11 revisions of this API.42

    • for the query request parameter direction, default value was changed from asc to desc

      request-parameter-default-value-changed

    • for the query request parameter sort, default value was changed from created_at to updated_at

      request-parameter-default-value-changed

    • removed the media type */* for the response with the status 401

      response-media-type-removed

    • removed the media type */* for the response with the status 403

      response-media-type-removed

    • added the new enum value updated_at to the query request parameter sort

      request-parameter-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added