...
The MerchantAuth complex type allows for the delivery of the client credentials to authorize service requests.
MerchantAuth Fields
Field Name | Required Optional Conditional Read Only (RO) | Data Type & Length | Description & Field Values |
---|---|---|---|
login | RO | string | This is the login identifier supplied by OmniFund. This can be the six digit Merchant ID or the OAuth client_id. Required if no access_token is supplied |
pin | RO | string | The associated gateway pin to the Merchant ID supplied in the 'login' field, or the associated client_secret associated with the client_id. Required if no access_token is supplied |
access_token | O | string | Valid OAuth access token. |
access_key | O or CR | string | Provide API access key pair parameters in lieu of standard MerchantAuth fields - CONDITIONALLY REQUIRED: if access_key parameter is supplied, access_secret parameter must also be supplied. For more information on obtaining an API access key, see: Managing API Access Keys |
access_secret | O or CR | string | Provide API access key pair parameters in lieu of standard MerchantAuth fields - CONDITIONALLY REQUIRED: if access_key parameter is supplied, access_secret parameter must also be supplied. For more information on obtaining an API access key, see: Managing API Access Keys |
source_description | O | string | Description of the source originating the request. |
module_description | O | string | Description of the module originating the request. |
CustomerInfo
Customers or Customer Records are the individual people or companies that are customers to the Business(MID) we are working with. Typical customer data is Name, Address, Phone number etc. There are two unique fields in GTB that help identify customers. More will be explained below but one is a unique internal ID created by GTB called customer_id and the other one is created externally by the business called customer_name. The customer_name created by the business allows them to use a unique value from their accounting or other customer service systems so they can tie their data to the data in GTB.
...