| Donor transaction information |
| GET /api/v2/pay/donor_transaction_information | SESSION |
| Header name | Description |
|---|---|
|
Cookie required |
Login session cookie |
|
Provision required |
Web/Mobile/API Provision UUID |
| Param name | Description |
|---|---|
|
donor_guid required |
guid of the donor Validations:
|
|
start_date required |
lower bound for transaction date. Expects format YYYY-MM-DD Validations:
|
|
end_date required |
upper bound for transaction date. Expects format YYYY-MM-DD Validations:
|
check gift reports with matching donorguid
| Param name | Description |
|---|---|
|
data required |
donor transaction information Validations:
|
|
data[id] required |
ID of the donor transaction information Validations:
|
|
data[type] required |
Type of record Validations:
|
|
data[attributes] required |
Attributes of the donor transaction information Validations:
|
|
data[attributes][DonorGUID] required |
guid of the donor Validations:
|
|
data[attributes][TransactionGUID] required |
guid of the transaction Validations:
|
|
data[attributes][TransactionID] required |
ID of the transaction Validations:
|
|
data[attributes][AccountScheduleGUID] required |
GUID of the account schedule Validations:
|
|
data[attributes][AccountScheduleID] required |
ID of the account schedule Validations:
|
|
data[attributes][AccountScheduleStatus] required |
status of the account schedule Validations:
|
|
data[attributes][AccountScheduleStatusName] required |
status name of the account schedule Validations:
|
|
data[attributes][RecurringType] required |
type of the recurring setup Validations:
|
|
data[attributes][RecurringName] required |
type name of the recurring setup Validations:
|
|
data[attributes][NextRecurringDT] required |
next recurring date time Validations:
|
|
data[attributes][AccountGUID] required |
guid of the account Validations:
|
|
data[attributes][Amount] required |
transaction income amount Validations:
|
|
data[attributes][TransactionDate] required |
date of the transaction Validations:
|
|
data[attributes][SettlementDate] required |
date of the settlement Validations:
|
|
data[attributes][Status] required |
status of the transaction Validations:
|
|
data[attributes][IsRefundable] required |
if the transaction is refundable Validations:
|
|
data[attributes][RefundTransactionGUID] required |
transaction GUID of the refund Validations:
|
|
data[attributes][ResponseCode] required |
response code Validations:
|
|
data[attributes][ResponseCodeAVS] required |
response code AVS Validations:
|
|
data[attributes][InvoiceNumber] required |
invoice number Validations:
|
|
data[attributes][CustomerTransactionID] required |
transaction id of the customer Validations:
|
|
data[attributes][UserDefinedData1] required |
user defined data Validations:
|
|
data[attributes][UserDefinedData2] required |
user defined data Validations:
|
|
data[attributes][UserDefinedData3] required |
user defined data Validations:
|
|
data[attributes][AccountNickName] required |
nick name of the account Validations:
|
|
data[attributes][AccountType] required |
type of the account Validations:
|
|
data[attributes][MaskedACHNum] required |
masked account number Validations:
|
|
data[attributes][BankName] required |
name of the bank Validations:
|
|
data[attributes][CreditCardType] required |
type of the credit card Validations:
|
|
data[attributes][MaskedCCNum] required |
masked credit card number Validations:
|
|
data[attributes][designation_information] required |
Attributes of the designation_information Validations:
|
|
data[attributes][designation_information][DesignationID] required |
designation id Validations:
|
|
data[attributes][designation_information][DesignationGUID] required |
designation guid Validations:
|
|
data[attributes][designation_information][DesignationName] required |
designation name Validations:
|
|
data[attributes][designation_information][DesignationAmount] required |
designation amount Validations:
|
|
data[attributes][designation_information][DesignationAllocationID] required |
id of the designation allocation Validations:
|
|
data[attributes][designation_information][designationmemo] required |
designation memo Validations:
|
Unauthorized
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Not Found
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Unprocessable Entity
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Internal Server Error
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
| 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 | The start date or end date is invalid |
| 422 | Start date cannot be greater than the end date |
| 500 | No connection to data source |