REST Objects Payment Provider

5.0.0 5.9.4

The Payment Provider object is part of the overall ServiceBroker Configuration object, in the following location:

Configuration > Providers > Payment Provider

A Payment Provider object is used within the context of a REST Objects Providers (itself part of an REST Objects Configuration) to represent the details of how ServiceBroker is to be integrated with a payment provider for the relevant tenant.

On this page:

Related pages:

Payment Provider Object Format - authorize.net

JSON Format

{
    "Provider": "AuthorizeNet",
    "Features": {
        "RequestPayment": {
            "HostedPaymentSettings": {
                "hostedPaymentReturnOptions": {
                    "showReceipt": false
                },
                "hostedPaymentButtonOptions": {
                    "text": "Pay"
                },
                "hostedPaymentStyleOptions": {
                    "bgColor": "#2185c7"
                },
                "hostedPaymentPaymentOptions": {
                    "cardCodeRequired": true,
                    "showCreditCard": true,
                    "showBankAccount": false
                },
                "hostedPaymentSecurityOptions": {
                    "captcha": true
                },
                "hostedPaymentShippingAddressOptions": {
                    "show": true,
                    "required": false
                },
                "hostedPaymentBillingAddressOptions": {
                    "show": false,
                    "required": false
                },
                "hostedPaymentCustomerOptions": {
                    "showEmail": true,
                    "requiredEmail": false,
                    "addPaymentProfile": false
                },
                "hostedPaymentOrderOptions": {
                    "show": false
                },
                "hostedPaymentIFrameCommunicatorUrl": {
                    "url": ""
                }
            }
        },
        "ConfirmPayment": {
        }
    },
	"SecretKey": "",
	"MerchantAuthentication": {
    	"Name": "",
        "TransactionKey": ""
    },
    "BaseUrl": ""
}

Payment Provider Object Properties - authorize.net

Property					Type	Required?	Description
`Provider`					`string`	Yes	The payment provider to use. For authorize.net, the value is: `AuthorizeNet`.
`Features`					`object`	Yes	An object to be passed to the payment provider when requesting payments.
	`RequestPayment`				`object`	Yes	Object defining the endpoint and parameters to be passed to authorize.net when initializing payments.
		`HostedPaymentSettings`			`object`	Yes
			`hostedPaymentReturnOptions`		`object`	Yes
				`showReceipt`	`boolean`	Yes
			`hostedPaymentButtonOptions`		`object`	Yes
				`text`	`string`	Yes
			`hostedPaymentStyleOptions`		`object`	Yes
				`bgColor`	`string`	Yes
			`hostedPaymentPaymentOptions`		`object`	Yes
				`cardCodeRequired`	`boolean`	Yes
				`showCreditCard`	`boolean`	Yes
				`showBankAccount`	`boolean`	Yes
			`hostedPaymentSecurityOptions`		`object`	Yes
				`captcha`	`boolean`	Yes
			`hostedPaymentShippingAddressOptions`		`object`	Yes
				`show`	`boolean`	Yes
				`required`	`boolean`	Yes
			`hostedPaymentBillingAddressOptions`		`object`	Yes
				`show`	`boolean`	Yes
				`required`	`boolean`	Yes
			`hostedPaymentCustomerOptions`		`object`	Yes
				`showEmail`	`boolean`	Yes
				`requiredEmail`	`boolean`	Yes
				`addPaymentProfile`	`boolean`	Yes
			`hostedPaymentOrderOptions`		`object`	Yes
				`show`	`boolean`	Yes
			`hostedPaymentIFrameCommunicatorUrl`		`object`	Yes
				`url`	`string`	Yes
	`ConfirmPayment`				`object`	Yes	Empty object.
`SecretKey`					`string`	Yes
`MerchantAuthentication`					`object`	Yes
	`Name`				`string`	Yes
	`TransactionKey`				`string`	Yes
`BaseUrl`					`string`	Yes	The base URL of the payment provider. Currently, only https://www.chasepaymentechhostedpay-var.com is supported.

Payment Provider Object Format - Chase Payment

JSON Format

{
    "Provider": "ChasePayment",
    "Features": {
        "RequestPayment": {
            "InitParams": {
                "hostedSecureID": "{HostedSecureId}",
                "hostedSecureAPIToken": "{HostedSecureApiToken}",
                "css_url": "{CssUrl}",
                "action": "{Action}",
                "payment_type": "{PaymentType}",
                "formType": "{FormType}",
                "allowed_types": "{AllowedTypes}",
                "trans_type": "{TransType}",
                "currency_code": "{CurrencyCode}",
                "required": "{Required}",
                "hosted_tokenize": "{HostedTokenize}"
            },
            "RenderParams": {
                "hostedSecureID": "{HostedSecureId}"
            }
        },
        "ConfirmPayment": {
            "QueryParams": {
                "hostedSecureID": "{HostedSecureId}",
                "hostedSecureAPIToken": "{HostedSecureApiToken}"
            }
        }
    },
    "Headers": {},
    "Props": {
        "HostedSecureId": "",
        "HostedSecureApiToken": "",
        "CssUrl": "",
        "Action": "",
        "PaymentType": "",
        "FormType": "",
        "AllowedTypes": "",
        "TransType": "",
        "CurrencyCode": "",
        "Required": "",
        "HostedTokenize": ""
    }
}

Payment Provider Object Properties - Chase Payment

Property				Type	Required?	Description
`Provider`				`string`	Yes	The payment provider to use. For Chase Payment, the value is: `ChasePayment`.
`Features`				`object`	Yes	An object to be passed to the payment provider when requesting payments. The object contains placeholder variables, defined as `{variables}` which will be replaced by the corresponding values from the `Props` object below.
	`RequestPayment`			`object`	Yes	Object defining the endpoint and parameters to be passed to Chase when initializing payments.
		`InitParams`		`object`	Yes	Chase-defined parameters to be passed when initializing payments.
			`hostedSecureID`	`string`	Yes	Variable: `{HostedSecureId}` When sent to Chase, will be replaced by the value of the `Props > HostedSecureId` value.
			`hostedSecureAPIToken`	`string`	Yes	Variable: `{HostedSecureApiToken}` When sent to Chase, will be replaced by the value of the `Props > HostedSecureApiToken` value.
			`css_url`	`string`	Yes	Variable: `{CssUrl}` When sent to Chase, will be replaced by the value of the `Props > CssUrl` value.
			`action`	`string`	Yes	Variable: `{Action}` When sent to Chase, will be replaced by the value of the `Props > Action` value.
			`payment_type`	`string`	Yes	Variable: `{PaymentType}` When sent to Chase, will be replaced by the value of the `Props > PaymentType` value.
			`formType`	`string`	Yes	Variable: `{FormType}` When sent to Chase, will be replaced by the value of the `Props > FormType` value.
			`allowed_types`	`string`	Yes	Variable: `{AllowedTypes}` When sent to Chase, will be replaced by the value of the `Props > AllowedTypes` value.
			`trans_type`	`string`	Yes	Variable: `{TransType}` When sent to Chase, will be replaced by the value of the `Props > TransType` value.
			`currency_code`	`string`	Yes	Variable: `{CurrencyCode}` When sent to Chase, will be replaced by the value of the `Props > CurrencyCode` value.
			`required`	`string`	Yes	Variable: `{Required}` When sent to Chase, will be replaced by the value of the `Props > Required` value.
			`hosted_tokenize`	`string`	Yes	Variable: `{HostedTokenize}` When sent to Chase, will be replaced by the value of the `Props > HostedTokenize` value.
		`RenderParams`			Yes	Chase-defined parameters to be passed when rendering the payment system screen.
			`hostedSecureID`	`string`	Yes	Variable: `{HostedSecureId}` When sent to Chase, will be replaced by the value of the `Props > HostedSecureId` value.
	`ConfirmPayment`				Yes	Object defining the endpoint and parameters to be passed to Chase when querying payments.
		`QueryParams`			Yes	Chase-defined parameters to be passed when querying payments.
			`hostedSecureID`	`string`	Yes	Variable: `{HostedSecureId}` When sent to Chase, will be replaced by the value of the `Props > HostedSecureId` value.
			`hostedSecureAPIToken`	`string`	Yes	Variable: `{HostedSecureApiToken}` When sent to Chase, will be replaced by the value of the `Props > HostedSecureApiToken` value.
`Headers`				`object`	No
`Props`				`object`	Yes	An array of tenant-specific values which should be used to replace the `{variables}` defined in the specific payment provider's defined `Features` object when being sent to the provider.
	`HostedSecureId`			string	Yes	The tenant's specific Chase hosted secure ID value.
	`HostedSecureApiToken`			string	Yes	The tenant's specific Chase secure API token value.
	`CssUrl`			string	Yes	URL to an externally hosted, publicly accessible CSS file as required by Chase for format the payment system screen when rendered.
	`Action`			string	Yes	For Chase, the literal string: `buildForm`
	`PaymentType`			string	Yes	For Chase, the literal string: `Credit_Card`
	`FormType`			string	Yes	For Chase, the literal string: `4`
	`AllowedTypes`			string	Yes
	`TransType`			string	Yes	For Chase, the literal string: `auth_capture`
	`CurrencyCode`			string	Yes	The current for payments, as supported by Chase (e.g. `USD`).
	`Required`			string	Yes	For Chase, the literal string: `all`
	`HostedTokenize`			string	Yes	For Chase, the literal string: `store_authorize`