GET /api/v2/pay/verify_transactions
Get all verify transactions

Learn how to use Suran API on the Suran Help Center.

Headers

Header name Description
Cookie
required 		Login session cookie
Provision
required 		Web/Mobile/API Provision UUID

Params

Param name Description
donor_guid
required

guid of the donor

Validations:

  • Must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
account_schedule_guid
required

guid of the recurring setup

Validations:

  • Must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.

Returns

Code: 200

Description:

verify transaction

Param name Description
data
required

verify transaction

Validations:

  • Must be a Hash
data[id]
required

ID of the verify transaction

Validations:

  • Must be a number.
data[type]
required

Type of record

Validations:

  • Must be a String
data[attributes]
required

Attributes of the verify transaction

Validations:

  • Must be a Hash
data[attributes][AccountScheduleGUID]
required

GUID of the account schedule

Validations:

  • Must be a String
data[attributes][DonorGUID]
required

guid of the donor

Validations:

  • Must be a String
data[attributes][AccountGUID]
required

guid of the account

Validations:

  • Must be a String
data[attributes][AccountScheduleStatus]
required

status of the recurring setup

Validations:

  • Must be a String
data[attributes][Amount]
required

amount donated

Validations:

  • Must be a String
data[attributes][ScheduledDate]
required

next recurring date

Validations:

  • Must be a String
data[attributes][RecurringType]
required

type of the recurring setup

Validations:

  • Must be a String
data[attributes][Quantity]
required

number of recurring setups

Validations:

  • Must be a String
data[attributes][RecurringName]
required

type name of the recurring setup

Validations:

  • Must be a String
data[attributes][Memo]
required

recurring setup memo

Validations:

  • Must be a String
data[attributes][InvoiceNumber]
required

empty

Validations:

  • Must be a String
data[attributes][CustomerTransactionID]
required

empty

Validations:

  • Must be a String
data[attributes][UserDefinedData1]
required

empty

Validations:

  • Must be a String
data[attributes][UserDefinedData2]
required

empty

Validations:

  • Must be a String
data[attributes][UserDefinedData3]
required

empty

Validations:

  • Must be a String
data[attributes][TransactionGUID]
required

guid of the transaction

Validations:

  • Must be a String
data[attributes][TransactionDate]
required

date of the transaction

Validations:

  • Must be a String
data[attributes][SettlementDate]
required

deposit date

Validations:

  • Must be a String
data[attributes][TransactionStatus]
required

status of the transaction

Validations:

  • Must be a String
data[attributes][ResponseCode]
required

transaction response code

Validations:

  • Must be a String
data[attributes][ResponseCodeDescr]
required

transaction id of the customer

Validations:

  • Must be a String
data[attributes][ResponseCodeAVS]
required

user defined data

Validations:

  • Must be a String
data[attributes][FileID]
required

user defined data

Validations:

  • Must be a String
data[attributes][designation_information]
required

Attributes of the designation_information

Validations:

  • Must be a Hash
data[attributes][designation_information][DesignationID]
required

designation id

Validations:

  • Must be a String
data[attributes][designation_information][DesignationGUID]
required

designation guid

Validations:

  • Must be a String
data[attributes][designation_information][DesignationName]
required

designation name

Validations:

  • Must be a String
data[attributes][designation_information][DesignationAmount]
required

designation amount

Validations:

  • Must be a String
data[attributes][designation_information][DesignationAllocationID]
required

id of the designation allocation

Validations:

  • Must be a String
data[attributes][designation_information][designationmemo]
required

designation memo

Validations:

  • Must be a String

Code: 401

Description:

Unauthorized

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 404

Description:

Not Found

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 422

Description:

Unprocessable Entity

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 500

Description:

Internal Server Error

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Errors

Code Description
404 Data source query failed
422 Invalid parameter(s)
422 Provision header missing
422 Invalid provision
422 Under maintenance
422 Incorrect host for provision
422 Establishing session failed
422 Privilege to perform the action was not found
422 Not logged in
422 Provision does not match logged in provision
500 No connection to data source