Page Comparison

Tip
Available from CRM.COM R11.0.0

Excerpt
This method is used to set multiple payment gateway requests, which are in a "Pending" or "Under Processing" life cycle state, to a "Rejected" state within a single Web API method call. Note that the maximum number of payment gateway requests that can be specified is 1000

...

Name	Type	Description
token	String	The token retrieved from the login method
payment_gateway_requests_set (mandatory)	Set of Payment Gateway Request Objects	The set of payment gateway requests that will be processed by this Web API method. Only payment gateway requests which are in a "Pending" or "Under Processing" life cycle state can be specified. Note that the maximum number of payment gateway requests that can be specified within a single Web API call is 1000
fields_set (optional)	List of Strings, comma separated	A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Expand

title	bulk payment gateway request parameter object data

Name

Type

Description

request_unique_identifier

(mandatory)

String

A unique identifier of the request, provided by the caller, in order to identify the successful or failed results. Note that this information should be unique and is not stored within CRM.COM

payment_gateway_request_identifier

(mandatory)

Payment Gateway Request Identifier

The payment gateway request that will be set as "Rejected". Only pending or under processing payment gateway requests can be specified. The allowed payment gateway request identifier fields are the following:

Include Page

	V4:payment_gateway_request_identifier
	V4:payment_gateway_request_identifier

reference_number

(optional)

String

A reference number that will be set on the payment gateway request that will be set as "Rejected".

error_code

(optional)

String

The error code related with to the rejected payment gateway request

error_description

(optional)

String

The error description related with to the rejected payment gateway request

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "token":"{{token}}",
  "payment_gateway_requests_set":
   [
        {
            "request_unique_identifier":"01",
            "payment_gateway_request_identifier":{"number":"56"},
            "error_code":"XS001",
            "error_description":"Rejected due to invalid data.",
            "reference_number":"ref001"
        },
        {
            "request_unique_identifier":"02",
            "payment_gateway_request_identifier":{"number":"47"},
            "error_code":"XS005",
            "reference_number":"ref002"
        },
        {
            "request_unique_identifier":"03",
            "payment_gateway_request_identifier":{"number":"59"},
            "reference_number":"ref003"
        }
    ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "data": {
    "processed_payment_gateway_requests_set": [
      {
        "number": "59",
        "id": "342C6DE115444FC0A9C785CA59B7A816",
        "request_unique_identifier": "03"
      }
    ],
    "unprocessed_payment_gateway_requests_set": [
      {
        "error_description": "Error:Cannot Reject Payment Gateway Request. Payment Gateway Request Life Cycle State Should Be: Pending, Under Processing. - Description:Cannot reject Payment Gateway Request.",
        "error_code": "CannotRejectPaymentGatewayRequestException",
        "request_unique_identifier": "01"
      },
      {
        "error_description": "Error:Cannot Reject Payment Gateway Request. Payment Life Cycle State Should Be: Pending Verification. - Description:Cannot reject Payment Gateway Request.",
        "error_code": "CannotRejectPaymentGatewayRequestException",
        "request_unique_identifier": "02"
      }
    ]
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

Versions Compared

Old Version 3

New Version Current

Key