Answer Format

Note: For supported statuses please see Statuses per Method.

Each plug-in must return responses that include the response body and the response code.

HTTP Response Сode

For successful responses, each plug-in must return HTTP codes 200 or 201. Only these HTTP codes are considered by Billing as successful responses.

HTTP Response Body

Name	Type	Mandatory	Values	Description
`STATUS`	string	yes	APPROVED FRAUD DECLINED 3DSECURE >PENDING AUTHCALL ERROR REDIRECT MODAL	Operation result status. Note: For information on supported statuses for each method refer to Statuses per Method.
`TRANSACTION_DETAILS`	array	no	name-value	The array that will be associated with current transaction and will be represented back in unchanged form as the value of the `previous_transaction_data` parameter at the next call of transaction processing methods of the plug-in. Note: Billing looks up the `trans_id` parameter that identifies a transaction on the gateway side to show it in the provider's UI. So, we highly recommend that you use this parameter.
`NEXT_TRANSACTION_GAP`	integer	mandatory for status PENDING	1..*	The delay in seconds before transaction processing attempt will be repeated.
`REDIRECT_HASH`	struct	mandatory for status REDIRECT		Provide information for redirect. Parameters: `url` - The URL where customer should be redirected. String, mandatory. `attrs` - Parameters and values which will be used for redirect. Array, mandatory. `method` - The method used to pass the data: GET, POST. If not set POST method will be used. String, optional.
`TEXT`	struct	no		The array that contains the following parameters: `customer_message` contains text that will be shown to customer as status message. `vendor_message` contains text that will be shown to vendor.
`ADD_NEW_METHOD`	array	no		If this array is passed, Billing tries to add a new payment method: e.g., creates token after redirect. Billing looks up the `paymethod_name` parameter to save a payment method, so that parameter is required to payment method be added. if the payment method has an expiration date, the expiration date may be included by parameter `exp_date` in the MM/YYYY format. All the other name-value pairs will be stored and passed to the plug-in with the next payment operation.
NOTIFY_RESPONSE	array	no		The array that can produce response on the Notify URL request. Parameters: body - HTTP response body. String, mandatory. content_type - content type for HTTP response body (available values are `"text/plain", "text/html", "application/json")`. String, mandatory.
MODAL_FORM	array	no		The array that passes the attributes (required for displaying the checkout modal form) to UI. Parameters: `checkout_script_section` - ID of HTML <div> element that contains HTML elements needed to open the form. String, mandatory. `checkout_script_src` - URL to vendor's Javascript needed to build the form. String, mandatory. `checkout_script_handler` - Javascript code that launch Javascript checkout script. String, mandatory. `checkout_script_html` - extra HTML code that can be used for checkout. String, not mandatory.

Answer Format

Related Topics