Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Merchant credentials can be submitted in a couple of different ways.  The legacy method of using the six digit merchant ID and gateway pin, or using an API access key pair.  Only one set of credentials are required.  It is recommended to use the API key pair which allows for greater control over the credentials.  You can generate an Access key pair in the OmniFund dashboard by visiting:  Profile > API Access

API Access Key Pair

For more information on obtaining an API access key, see: Managing API Access Keys

FieldRequiredDescription
access_keyRequiredGenerated API access key
access_key_secretRequiredKey secret associated with the given access_key

OAuth2 Client ID & Secret

For more information on obtaining an API access key, see: Managing OAuth Clients

FieldRequiredDescription
client_idRequiredGenerated Client ID
client_secretRequiredClient secret associated with the given client_id

OAuth2 Client ID & Access Token

For more information on obtaining an API access key, see: Managing OAuth Clients

FieldRequiredDescription
client_idRequiredGenerated Client ID
access_tokenRequiredUser access token

Merchant ID and PIN (deprecated)

...

FieldRequiredDescription
merchant_idRequiredMerchant ID assigned by gotoBilling
merchant_pinRequiredMerchant Pin associated with the Merchant ID. Assigned by gotoBilling

API Access Key Pair

For more information on obtaining an API access key, see: Managing API Access Keys

FieldRequiredDescription
access_keyRequiredGenerated API access key
access_key_secretRequiredKey secret associated with the given access_key

Optional Fields

FieldRequiredMax LengthDescription
x_relay_urlOptionalan. ..Contains the URL to which the gateway will post the response. Include http:// or https://. When set the gateway response will automatically be sent via HTTP POST to this location.
x_relay_typeOptionala. 7Indicates the type of action of the response. When ACTIVE is set the browser will automatically be sent to the location specified with x_relay_url. When PASSIVE is set the browser will not be redirected, but the response will be sent to the location specified with x_relay_url via HTTP POST. This is set to default to PASSIVE
x_debugOptionaln. 1When set to 1 (numerical one) transactions will be sent in test mode. A response will be given for the transaction, but no processing will occur. Default: 0 (zero).

...