Designations select

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

>>>

GET /api/v2/pay/designations_select SESSION
Get all designations

Headers

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

Returns

Code: 200

Description:

designations

Param name Description
data
required

designations select

Validations:

  • Must be a Hash
data[id]
required

ID of the designation

Validations:

  • Must be a String
data[type]
required

Type of select

Validations:

  • Must be a String
data[attributes]
required

Attributes of the designation

Validations:

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

GUID of the designation. (This is not tracked, expect null)

Validations:

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

Name of the designation

Validations:

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

Summary of the designation. (This is not tracked, expect null)

Validations:

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

Description of the designation

Validations:

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

Is this tax deductible?

Validations:

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

Was the payment type ACH?

Validations:

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

Was the payment type Visa?

Validations:

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

Was the payment type Mastercard?

Validations:

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

Was the payment type Ameican Express?

Validations:

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

Was the payment type Discover?

Validations:

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

Suggested designation amount. (This is not tracked, expect null)

Validations:

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

Date of expiration

Validations:

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

Maximum limit of funds. (This is not tracked, expect null)

Validations:

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

(This is not tracked, expect null)

Validations:

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

ID of the designation

Validations:

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

(This is not tracked, expect null)

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