Request
POST |
/api/Payer/SendCustomMessage |
Creates a custom DDMS message to a Payer and insert it into the message queue. |
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 |
256an |
M |
PayerReference |
The PayGate reference of the payer |
10c |
M |
CustomMessageType |
There are five available custom messages. Which one is created is determined here. |
CustomMessage1 CustomMessage2 CustomMessage3 CustomMessage4 CustomMessage5 |
M |
Key
O Optional
M Mandatory
C Conditional
an Alpha Numeric
c characters
Example JSON Request Object
{
"Username": "myusername",
"Password": "mypassword",
"ApiKey": "446d2f5c90ecce2b34eead3af6224b013c4adc23c764f265e9e96e105f0db831",
"PayerReference": "MyPayer123",
"CustomMessageType": "CustomMessage1",
}