• Suran API v2 /
  • Deposit designation detail by deposit dates

Deposit designation detail by deposit dates

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

>>>

GET /api/v2/pay/deposit_designation_detail_by_deposit_date SESSION
Get all deposit designation details

Headers

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

Params

Param name Description
start_date
required

Lower bound for DepositDate. Expects format YYYY-MM-DD

Validations:

  • Must be a String
end_date
required

Upper bound for DepositDate. Expects format YYYY-MM-DD

Validations:

  • Must be a String

Returns

Code: 200

Description:

Deposit Designation Details

Param name Description
data
required

deposit designation detail by deposit date

Validations:

  • Must be a Hash
data[id]
required

ID of the deposit designation detail

Validations:

  • Must be a number.
data[type]
required

Type of the charge

Validations:

  • Must be a String
data[attributes]
required

Attributes of the deposit designation detail

Validations:

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

ID of the transaction

Validations:

  • Must be a number.
data[attributes][DepositID]
required

ID of the deposit

Validations:

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

Date of the deposit

Validations:

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

Date of the settlement

Validations:

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

ID of the transaction

Validations:

  • Must be a number.
data[attributes][TransactionGUID]
required

GUID of the transaction

Validations:

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

ID of the donor

Validations:

  • Must be a number.
data[attributes][DonorGUID]
required

GUID of the donor

Validations:

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

The transaction donor

Validations:

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

Amount of the transaction

Validations:

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

Fee amount of the transaction

Validations:

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

Net amount of the transaction.

Validations:

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

Status of the transaction

Validations:

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

ID of the designation

Validations:

  • Must be a number.
data[attributes][DesignationGUID]
required

GUID of the designation. (This is currently untracked, and is expected to be NULL.)

Validations:

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

Name of the designation

Validations:

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

Memo of the designation

Validations:

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

Is the deposit designation detail anonymous? (We do not currently support anonymous transactions. This will always be false.)

Validations:

  • Must be one of: t, f, true, false, 1, 0, y, n, yes, no.
data[attributes][MainMemo]
required

Main memo of the deposit designation detail

Validations:

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

Memo of the deposit designation detail. (This has been depreciated, and is expected to be NULL.)

Validations:

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

Is the deposit designation detail anonymous? (We do not currently support anonymous transactions. This will always be false.)

Validations:

  • Must be one of: t, f, true, false, 1, 0, y, n, yes, no.

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
422 A date parameter was invalid or the start_date parameter was greater than the end_date parameter
500 No connection to data source