POST api/v1/Payments

Sends the payment receipt to the emails specified.

Request Information

URI Parameters

None.

Body Parameters

PaymentReceiptRequest
NameDescriptionTypeAdditional information
JobID

The jobID that we would like to send payment receipt for

integer

None.

AdditionalEmails

List of emails addresses to receive the payment receipt

Collection of string

None.

Name

The name of the recipient

string

None.

BillingAddress

Billing Address of the individual that requested the receipt

string

None.

Request Formats

application/json, text/json

Sample:
{
  "jobID": 1,
  "additionalEmails": [
    "sample string 1",
    "sample string 2"
  ],
  "name": "sample string 2",
  "billingAddress": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaymentReceipt
NameDescriptionTypeAdditional information
IsSuccess

Returns if the email was send successfully

boolean

None.

ExtRefID

An external reference provided by you returned to you. This should not be visible to the end user and only serves the purpose to link up different system.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "extRefID": "sample string 2"
}