Skip to main content
GET
cURL

Authorizations

x-api-key
string
header
required

Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.

x-secret-key
string
header
required

Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).

Path Parameters

campaign_id
string
required
Pattern: ^[A-Za-z0-9_-]{4,64}$

Query Parameters

status
enum<string>
Available options:
pending,
completed,
declined,
failed
updated_since
string<date-time>

ISO 8601 date-time

limit
integer
default:50

1 to 100, default 50

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page

Maximum string length: 512

Response

One page

success
boolean
message
string
data
object