VOvopay
Delivery Channel Endpoints

gcm/delivery-channels/fields

Get a list of all the fields required for a certain delivery method.

get/gcm/delivery-channels/fields

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/gcm/delivery-channels/fields
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

DeliveryChannelIDstring required

The delivery channel ID

FieldForstring

The field for which the details are required

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

Example response

{
  "Success": true,
  "DeliveryChannelFields": {
    "0": {
      "Label": "Business Name",
      "FieldID": "BusinessName",
      "InputType": "text",
      "RequirementStatus": "required",
      "FieldFor": "sender",
      "Group": "user-info",
      "GroupOrder": "1"
    }
  }
}

Changes

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