POST api/payment/getPaymentRedirectTokenDto

Request Information

URI Parameters

None.

Body Parameters

PaymentRedirectObtainTokenDto
NameDescriptionTypeAdditional information
ContactID

integer

None.

SessionID

integer

None.

DebtrakAccountID

integer

None.

TokenRequestURL

string

None.

UserName

string

None.

Password

string

None.

SupplierBusinessCode

string

None.

PrincipalAmount

decimal number

None.

PaymentReference

string

None.

ReturnURL

string

None.

CancelURL

string

None.

ServerReturnURL

string

None.

ErrorEmailToAddress

string

None.

TransactionNumber

string

None.

Staff

boolean

None.

RedirectURL

string

None.

TokenID

integer

None.

PartnerID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ContactID": 1,
  "SessionID": 1,
  "DebtrakAccountID": 1,
  "TokenRequestURL": "sample string 2",
  "UserName": "sample string 3",
  "Password": "sample string 4",
  "SupplierBusinessCode": "sample string 5",
  "PrincipalAmount": 6.0,
  "PaymentReference": "sample string 7",
  "ReturnURL": "sample string 8",
  "CancelURL": "sample string 9",
  "ServerReturnURL": "sample string 10",
  "ErrorEmailToAddress": "sample string 11",
  "TransactionNumber": "sample string 12",
  "Staff": true,
  "RedirectURL": "sample string 14",
  "TokenID": 15,
  "PartnerID": 1
}

application/xml, text/xml

Sample:
<PaymentRedirectObtainTokenDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Dtos">
  <CancelURL>sample string 9</CancelURL>
  <ContactID>1</ContactID>
  <DebtrakAccountID>1</DebtrakAccountID>
  <ErrorEmailToAddress>sample string 11</ErrorEmailToAddress>
  <PartnerID>1</PartnerID>
  <Password>sample string 4</Password>
  <PaymentReference>sample string 7</PaymentReference>
  <PrincipalAmount>6</PrincipalAmount>
  <RedirectURL>sample string 14</RedirectURL>
  <ReturnURL>sample string 8</ReturnURL>
  <ServerReturnURL>sample string 10</ServerReturnURL>
  <SessionID>1</SessionID>
  <Staff>true</Staff>
  <SupplierBusinessCode>sample string 5</SupplierBusinessCode>
  <TokenID>15</TokenID>
  <TokenRequestURL>sample string 2</TokenRequestURL>
  <TransactionNumber>sample string 12</TransactionNumber>
  <UserName>sample string 3</UserName>
</PaymentRedirectObtainTokenDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaymentRedirectObtainTokenDto
NameDescriptionTypeAdditional information
ContactID

integer

None.

SessionID

integer

None.

DebtrakAccountID

integer

None.

TokenRequestURL

string

None.

UserName

string

None.

Password

string

None.

SupplierBusinessCode

string

None.

PrincipalAmount

decimal number

None.

PaymentReference

string

None.

ReturnURL

string

None.

CancelURL

string

None.

ServerReturnURL

string

None.

ErrorEmailToAddress

string

None.

TransactionNumber

string

None.

Staff

boolean

None.

RedirectURL

string

None.

TokenID

integer

None.

PartnerID

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "ContactID": 1,
  "SessionID": 1,
  "DebtrakAccountID": 1,
  "TokenRequestURL": "sample string 2",
  "UserName": "sample string 3",
  "Password": "sample string 4",
  "SupplierBusinessCode": "sample string 5",
  "PrincipalAmount": 6.0,
  "PaymentReference": "sample string 7",
  "ReturnURL": "sample string 8",
  "CancelURL": "sample string 9",
  "ServerReturnURL": "sample string 10",
  "ErrorEmailToAddress": "sample string 11",
  "TransactionNumber": "sample string 12",
  "Staff": true,
  "RedirectURL": "sample string 14",
  "TokenID": 15,
  "PartnerID": 1
}

application/xml, text/xml

Sample:
<PaymentRedirectObtainTokenDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Dtos">
  <CancelURL>sample string 9</CancelURL>
  <ContactID>1</ContactID>
  <DebtrakAccountID>1</DebtrakAccountID>
  <ErrorEmailToAddress>sample string 11</ErrorEmailToAddress>
  <PartnerID>1</PartnerID>
  <Password>sample string 4</Password>
  <PaymentReference>sample string 7</PaymentReference>
  <PrincipalAmount>6</PrincipalAmount>
  <RedirectURL>sample string 14</RedirectURL>
  <ReturnURL>sample string 8</ReturnURL>
  <ServerReturnURL>sample string 10</ServerReturnURL>
  <SessionID>1</SessionID>
  <Staff>true</Staff>
  <SupplierBusinessCode>sample string 5</SupplierBusinessCode>
  <TokenID>15</TokenID>
  <TokenRequestURL>sample string 2</TokenRequestURL>
  <TransactionNumber>sample string 12</TransactionNumber>
  <UserName>sample string 3</UserName>
</PaymentRedirectObtainTokenDto>