Select accounts

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

>>>

GET /api/v2/pay/select_accounts SESSION
Get all accounts

Headers

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

Params

Param name Description
DonorGUID
required

GUID of the Donor

Validations:

  • Must be a String
ShowAll
optional

Show all accounts? This value must be 1 or 0.

Validations:

  • Must be a number.

Returns

Code: 200

Description:

accounts

Param name Description
data
required

select accounts

Validations:

  • Must be a Hash
data[id]
required

ID of the donor

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][id]
required

ID of the donor

Validations:

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

Credit Cards for account

Validations:

  • Must be a Hash
data[attributes][CreditCards][CreditCard]
required

Individual Credit Card for account

Validations:

  • Must be a Hash
data[attributes][CreditCards][CreditCard][AccountGUID]
required

GUID for credit card account

Validations:

  • Must be a String
data[attributes][CreditCards][CreditCard][NickName]
required

Nick name for credit card account

Validations:

  • Must be a String
data[attributes][CreditCards][CreditCard][ABARoutingNumber]
required

ABA routing number for credit card account

Validations:

  • Must be a String
data[attributes][CreditCards][CreditCard][BankName]
required

Name of the bank for credit card account

Validations:

  • Must be a String
data[attributes][CreditCards][CreditCard][MaskedAccountNumber]
required

Masked account number for credit card account

Validations:

  • Must be a String
data[attributes][CreditCards][CreditCard][Type]
required

Type of credit card account

Validations:

  • Must be a String
data[attributes][CreditCards][CreditCard][StatusCode]
required

Status code of credit card account

Validations:

  • Must be a String
data[attributes][CreditCards][CreditCard][StatusName]
required

Name/descriptor for status of credit card account

Validations:

  • Must be a String
data[attributes][CreditCards][CreditCard][IsNACHAValidated]
required

Is the credit card account NACHA validated?

Validations:

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

Bank Accounts for account

Validations:

  • Must be a Hash
data[attributes][BankAccounts][BankAccount]
required

Individual Bank Account for account

Validations:

  • Must be a Hash
data[attributes][BankAccounts][BankAccount][AccountGUID]
required

GUID for bank account

Validations:

  • Must be a String
data[attributes][BankAccounts][BankAccount][NickName]
required

Nick name for bank account

Validations:

  • Must be a String
data[attributes][BankAccounts][BankAccount][ABARoutingNumber]
required

ABA routing number for bank account

Validations:

  • Must be a String
data[attributes][BankAccounts][BankAccount][BankName]
required

Name of the bank for bank account

Validations:

  • Must be a String
data[attributes][BankAccounts][BankAccount][MaskedAccountNumber]
required

Masked account number for bank account

Validations:

  • Must be a String
data[attributes][BankAccounts][BankAccount][Type]
required

Type of bank account

Validations:

  • Must be a String
data[attributes][BankAccounts][BankAccount][StatusCode]
required

Status code of bank account

Validations:

  • Must be a String
data[attributes][BankAccounts][BankAccount][StatusName]
required

Name/descriptor for status of bank account

Validations:

  • Must be a String
data[attributes][BankAccounts][BankAccount][IsNACHAValidated]
required

Is the bank account NACHA validated? (Currently Untracked, 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