batch/contacts/add

This endpoint is used to submit multiple contact creation requests to VoPay. Each object in the batch is processed against the /contacts/add endpoint: EmailAddress and PhoneNumber are always required, and either BusinessName or both FirstName and LastName must be provided. Each row may also carry an optional payment method, created with the contact and set as its default, using the keys PaymentMethod, PaymentMethodDetails and the optional PaymentMethodCurrency, with the same values, formats and rules as /contacts/add: PaymentMethod is bank, email, paypal, venmo or zelle (case-insensitive); for bank, PaymentMethodDetails is RoutingNumber-AccountNumber (US bank account), InstitutionNumber-TransitNumber-AccountNumber (Canadian bank account) or an IBAN; for email, paypal, venmo and zelle it is a single email address or phone number. PaymentMethodCurrency defaults to the account's currency and must be one the method can hold. When all are blank no payment method is created; supplying PaymentMethodDetails or PaymentMethodCurrency without PaymentMethod, or PaymentMethod without PaymentMethodDetails, rejects the row. The contact's own EmailAddress and PhoneNumber are never used as payment details. The payment method must be enabled on your account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Your account ID

string
required

API key for the account

string
required

Hashed signature for the request

string
required

Name of the batch

string
required

An array of objects. Each object contains the input params for the /contacts/add endpoint. This endpoint accepts a maximum of 5000 contacts per batch submission.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json