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).

Query Parameters

mandate_id
string

Record's mandate id (JM_...): the mandate_id returned when you create the mandate

Pattern: ^JM_[A-Z0-9]{10,40}$
job_id
string

Your own id (1 to 128 of A-Z a-z 0-9 . _ : -)

Pattern: ^[A-Za-z0-9._:-]{1,128}$
status
enum<string>
Available options:
draft,
waiting_for_questions,
blocked,
sending,
paused,
completed,
cancelled
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