Schedule

---

Endpoint

/v1/External/SchedulePayment

Http Request Method

PUT

Request Body

Name	Type	Description	Child Attributes
scheduleDetails	object	Details of the payment schedule.
donor	object	Information about the donor.
campaignNum	number	Campaign number associated with the payment, if any.	Placeholder
campaignName	string	Campaign name associated with the payment, if any.	Placeholder
reason	object	Reason for the payment.
amount	number	Total amount of the payment.	Placeholder
ccNum	string	Credit card number used for the payment.	Placeholder
expiry	string	Credit card expiration date (MMYY).	Placeholder
cvv	string	Credit card CVV security code.	Placeholder
note	string	Additional note for the payment.	Placeholder
paymentDate	string	Date and time of the payment in ISO format.	Placeholder
paymentMethodId	number	Identifier for the payment method used.	Placeholder
uniqueTransactionId	string	Unique identifier for the transaction.	Placeholder
currency	string	Currency code (e.g., USD) used for the payment.	Placeholder
reasons	array	List of reasons associated with the payment.
bankAccount	object	Bank account information associated with the payment, if applicable.
orgGUID	string	Organization GUID associated with the payment.	Placeholder

Response

Name	Type	Description	Child Attributes
scheduleID	number | null	Identifier for the payment schedule, if applicable.	Placeholder
scheduleTotal	number | null	Total amount for the schedule, if applicable.	Placeholder
paymentId	number	Unique identifier for the payment transaction.	Placeholder
statusId	number	Identifier for the status of the payment.	Placeholder
serverRejected	string	Indicates if the payment was rejected by the server.	Placeholder
approval	string	Approval status of the payment.	Placeholder
receiptNum	string	Receipt number associated with the payment.	Placeholder
accountId	number	Identifier for the account associated with the payment.	Placeholder
currencyAmount	number	Amount of the payment in the specified currency.	Placeholder
currency	string	Currency code (e.g., USD) used for the payment.	Placeholder
paymentStatus	string	Current status of the payment.	Placeholder
isRecurring	boolean	Indicates whether the payment is recurring.	Placeholder
responseTitle	string | null	Title of the response message, if any.	Placeholder
isPaymentExist	boolean	Indicates whether a payment record exists.	Placeholder
errorResponse	string | null	Error response message, if any.	Placeholder
error	object	Details of any error that occurred.

See list of possible errors.

---

Example:

cURL:

curl --location 'https://dev.api.donary.com/v1/External/SchedulePayment' \
--header 'APIKey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{"scheduleDetails":{"amountPerPayment":1,"totalPaymentsCount":5,"startDate":"2024-08-08T11:29:00.595Z","frequencyID":1,"firstPaymentAmount":1},"donor":{"accountNum":null,"firstName":"Test","lastName":"Charity","phoneNumber":"1231231233"},"campaignNum":null,"campaignName":null,"reason":{"reasonNum":null,"reasonName":null},"amount":5,"ccNum":"4242424242424242","expiry":"1228","cvv":"456","note":"Test Schedule","paymentDate":"2024-08-11T11:29:00.595Z","paymentMethodId":4,"uniqueTransactionId":"0b94c505-b06e-4f97-90d2-f231c05f420f2-1","currency":"USD","reasons":[{"reasonNum":null,"reasonName":null,"reasonAmount":null}],"bankAccount":{"routingNum":null,"accountNum":null,"accountType":null,"checkType":null,"nameOnAccount":null},"orgGUID":"115e9d3d-baf2-4089-b896-9b2621ffcf1b"}'

Payload:

{
  "scheduleDetails": {
    "amountPerPayment": 1,
    "totalPaymentsCount": 5,
    "startDate": "2024-08-08T11:29:00.595Z",
    "frequencyID": 1,
    "firstPaymentAmount": 1
  },
  "donor": {
    "accountNum": null,
    "firstName": "Test",
    "lastName": "Charity",
    "phoneNumber": "1231231233"
  },
  "campaignNum": null,
  "campaignName": null,
  "reason": {
    "reasonNum": null,
    "reasonName": null
  },
  "amount": 5,
  "ccNum": "4242424242424242",
  "expiry": "1228",
  "cvv": "456",
  "note": "Test Schedule",
  "paymentDate": "2024-08-11T11:29:00.595Z",
  "paymentMethodId": 4,
  "uniqueTransactionId": "0b94c505-b06e-4f97-90d2-f231c05f420f2-1",
  "currency": "USD",
  "reasons": [
    {
      "reasonNum": null,
      "reasonName": null,
      "reasonAmount": null
    }
  ],
  "bankAccount": {
    "routingNum": null,
    "accountNum": null,
    "accountType": null,
    "checkType": null,
    "nameOnAccount": null
  },
  "orgGUID": "115e9d3d-baf2-4089-b896-9b2621ffcf1b"
}

Response:

{
    "scheduleID": null,
    "scheduleTotal": null,
    "paymentId": 4885712,
    "statusId": 1,
    "serverRejected": "",
    "approval": "Success",
    "receiptNum": "1087-1",
    "accountId": 3702852,
    "currencyAmount": 1.0000,
    "currency": "USD",
    "paymentStatus": "Success",
    "isRecurring": true,
    "responseTitle": null,
    "isPaymentExist": false,
    "errorResponse": null,
    "error": {
        "errorCode": null,
        "message": null
    }
}