Skip to end of banner
Go to start of banner

POST payment_gateway_requests/bulk/reject

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Available from CRM.COM R11.0.0

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

Resource URL

Parameters

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

Referred Parameter Objects


 bulk payment gateway request parameter object data

Name

Type

Description

request_unique_identifier

(mandatory)

StringA 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_identifierPayment 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:

Name

Type

Description

id

(semi-optional)

String

The id of the payment gateway request

number

(semi-optional)

String

The number of the retrieved payment gateway request

reference_numberStringA reference number that will be set on the payment gateway request that will be set as "Under Processing".
error_codeStringThe error code related with the rejected payment gateway request
error_descriptionStringThe error description related with the rejected payment gateway request

Response Data

Name

Type

Description

processed_payment_gateway_requests_set

Set of Processed Payment Gateway Request Objects

A set that contains the ID and the number of the payment gateway requests that were processed successfully

 

unprocessed_payment_gateway_requests_set

Set of Unprocessed Payment Gateway Request Objects

A set that contains the ID and the number of the payment gateway requests that were not processed successfully due to an error. Each row includes the unique request identifier , as provided by the caller, along with an error code and error description.

 

Referred Objects Response Data

 processed payment gateway request object response data

Name

Type

Description

request_unique_identifierStringA unique identifier of the request, as provided by the caller, in order to identify the successful results.

id

String

The ID of the payment gateway request

number

String

The number of the payment gateway request

 unprocessed payment gateway request object response data

Name

Type

Description

request_unique_identifierStringA unique identifier of the request, as provided by the caller, in order to identify the failed results.
error_code

String

The code of the error that was raised

error_descriptionString

The description of the error that was raised


Examples

 Example 1

HTTP Method: POST

 

Request:

Body:

{
  "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:

{
  "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": ""
  }
}
  • No labels