Request
POST |
/api/Payer/UpdateRegularAmounts |
Updates one or more regular payment amount of an existing Direct Debit payer |
Property |
Description |
Format |
Mandatory / Optional |
Username |
The username of the PayGate account that the API is running under |
M |
|
Password |
The password of the PayGate account that the API is running under |
M |
|
ApiKey |
The API key for the PayGate DDMS group that the payer will be added to |
256an |
M |
PayerReference |
The PayGate reference of the payer |
10c |
M |
SuppressPayerMessage |
Suppresses the creation of the 'Multiple Schedule Update' message from being added to the message queue. |
True False |
O Default is False |
Array of: |
|||
Amount |
The new regular collection amount |
A decimal amount (in UK pounds) E.g. 123.45 |
M |
DateFrom |
The date from which regular amounts will be amended. |
10an (dd/mm/yyyy) |
M |
Key
O Optional
M Mandatory
C Conditional
an Alpha Numeric
c characters
Example JSON Request Object
Example: Update the payer with reference MyPayer123 with several new regular amounts.
{
"Username": "apiuser@email.com",
"Password": "P@ssword02",
"ApiKey": "myApiKey",
"PayerReference": "MyPayer123",
"NewAmountData":
[
{
"Amount": 111.11,
"DateFrom": "21/2/2018"
},
{
"Amount": 222.22,
"DateFrom": "21/5/2018"
},
{
"Amount": 333.33,
"DateFrom": "21/9/2018"
}
]
}