POST | /partners | Creates a new partner. Fails if Partner Name is missing. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PartnerCode | body | string | Yes | The partner code. |
PartnerName | body | string | Yes | The partner name. |
OutboundUserName | body | string | No | The outbound username for this partner. |
OutboundPassword | body | string | No | The outbound password for this partner. |
OutboundUrl | body | string | No | The outbound url for this partner. |
InboundUserName | body | string | No | The inbound username for this partner. |
InboundPassword | body | string | No | The inbound password for this partner. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /partners HTTP/1.1
Host: api.paylock.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
partnerCode: String,
partnerName: String,
outboundUserName: String,
outboundPassword: String,
outboundUrl: String,
inboundUserName: String,
inboundPassword: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { id: 00000000000000000000000000000000 }