Batch Request Endpoints

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.

post/batch/contacts/add

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/batch/contacts/add
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

BatchNamestring required

Name of the batch

BatchDatastring 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

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

BatchTransactionRequestIDinteger required

Unique ID of your batch transaction request.

TotalSubmittedTransactionsinteger required

Total number of contacts submitted.

NumberOfRejectedTransactionsinteger required

Total number of rejected contacts.

RejectedTransactionsstring

JSON object containing the rejected contacts

Example response

{
  "Success": true,
  "RejectedTransactions": "{'1': 'Required parameter(s) missing: EmailAddress', '3': 'Required parameter(s) missing: FirstName, LastName'}"
}

Changes

No recorded changes to this operation across all 1 revision of this API.