Search for transfers
Find transfers by specified conditions. Conditions are passed as query parameters and can be combined or omitted. For example:
-
Find all transfers created in September 2024:
/v1/transfers/search?created_at=gte:2024-09-01T00:00:00Z&created_at=lt:2024-10-01T00:00:00Z
-
Find all transfers with a given
external_id
:/v1/transfers/search?external_id=custom_id_001
Note: external_id
is only available for transfers created using the Standalone integration.
Authorizations
Use partnerId
and secretKey
as the username and password respectively.
The client must send these credentials in the Authorization header, encoded in Base64.
The format for the header is Authorization: Basic {credentials}
, where "credentials" is
the Base64 encoding of "partnerId:secretKey"
.
Query Parameters
An external identifier that was provided at transfer time.
A filter which limits the results based on the created_at
time of the transfer. This value should be provided with in a format of operator:timestamp
.
Available operators:
gt
: Returns any values greater than the provided valuegte
: Returns any values greater than or equal to the provided valuelt
: Returns any values less than the provided valuegte
: Returns any values less than or equal to the provided value
The timestamp is a RFC 3339 timestamp.
This filter can be passed multiple times with different operators to create ranges:
created_at=gte:2024-09-01T00:00:00Z&created_at=lt:2024-10-01T00:00:00Z
The maximum number of results that will be returned.
1 <= x <= 20
The value to use for the the next page of results. Typically, this is the end_cursor
from the previous result set.
Response
An paged array of matching transfers
The response is of type object
.