Pay Links

Returns a pay link - a unique URL that when clicked, directs users to our FrontStream secure online payment page

post

Header parameters

AccessTokenstringRequired

access token

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

ApiKeystringRequired

required - Your API key for pay link authentication.

ProcessorGuidstring · nullableOptional

optional - Identifies Processor being used by an API Partner

IntegrationSourcestring · nullableOptional

optional and internal use - Identifies integrated Product

IpAddressstring · max: 40 · nullableOptional

client ip address where transaction originates

RedirectUrlstring · max: 500Required

required - The URL to which the user will be redirected after payment.

TranIdstring · max: 100 · nullableOptional

optional (max: 100) for API Partner Reference or Invoice number and Dup Checking - unique id per Integration Source transaction (where integration source has DupCheckEnabled) that will be checked against successfully processed prior TranIds for Duplicates

ShowTransactionIdboolean · nullableOptional

optional - 'True' will display the TranId on the checkout form. If set 'True' and optional TranId is not set, our form will allow for input to set TranId in form UI

TransactionIdTextstring · max: 100 · nullableOptional

optional (max: 100) - The text to display in front of the TranId. Example: Invoice#:

PoweredByTextstring · max: 100 · nullableOptional

optional (max: 100) - Text to display for branding purposes (e.g., "Powered by Your Company").

PoweredByUrlstring · max: 500 · nullableOptional

optional (max: 500) - The URL users will be directed to when clicking the PoweredByText.

DonateButtonTextstring · max: 100 · nullableOptional

optional (max: 100) - Text displayed on the submit payment button. Default is "Submit Payment".

Languagestring · max: 35 · nullableOptional

optional (max: 35) - The language of the pay link session. Default is "en" for english.

DefaultCountryCodestring · max: 2 · nullableOptional

optional - 2 char country code. The default country code for user input. Example: "US".

Themestring · max: 5000 · nullableOptional

optional (max: 5000) - CSS string for custom styling of the embedded session. Example: ".p-card-title{ color: rgb(255, 255, 255) !important; font-family: Open Sans !important}.EPF__body{ background-color: rgb(0, 0, 0); } .card {background: transparent !important;} .p-card{background: transparent !important;} .surface-card{background: transparent !important;}.p-card-title{ color: rgb(255, 255, 255) !important; font-family: Open Sans !important}.EPF__subheading__text{ color: rgb(255, 255, 255) !important; font-family: Open Sans !important}.EPF__body__text,.p-field-checkbox,.p-steps .p-steps-item .p-steps-title{ color: rgb(255, 255, 255) !important; font-family: Montserrat !important}.p-button-label{color:rgb(19, 5, 5) !important; font-family:Roboto;}.p-button{background-color:rgb(34, 136, 231) !important;border-radius:25px;border-color: transparent !important;}.p-button:hover{background-color:rgb(21, 110, 193) !important;}.p-button-label:hover{color:rgb(44, 30, 30) !important}.gpay-card-info-container{border-radius:25px!important;}.EPF__link__text{ color: rgb(216, 243, 255) !important; font-family: Montserrat !important}.EPF__form-element, .p-dropdown{ border:none !important; -webkit-box-shadow: none; box-shadow:none; background-color: transparent; border-bottom: 0.055rem solid gray !important; }.p-steps .p-steps-item.p-highlight .p-steps-number{background: rgb(34, 136, 231) !important;}.epf-cc {color: rgb(255, 255, 255);}.epf-cc-selected {color: rgb(34, 136, 231);}.p-button {color: rgb(19, 5, 5) !important;}.EPF__form-element:focus{color: #495057; -webkit-box-shadow: none !important; box-shadow:none !important; background-color: #FFFFFF !important; border-color: #4A4A4A !important;}.EPF_form-element--error{ -webkit-box-shadow: none !important; box-shadow:none !important; background-color: #F6CCD1 !important; border-color: #DC143C !important;}.EPF_form-element--error:focus{background-color: #F6CCD1 !important;}.has-error .input-group-addon { background-color: #F6CCD1 !important }.select--error { background: #F6CCD1 }.select--error ~ .fa-angle-down { display:none }.select--error:focus ~ .fa-angle-down { display: inline }.select--error:focus ~ .fa-exclamation-circle { display: none}.select--error:focus { background-color: #F6CCD1 }.exclamation-textArea { padding-top: 3.75rem }.form-field--invalid {border-color: #d0021b !important;}.form-field--invalid .p-dropdown {border-color: #d0021b !important;}.EPF__form-element, .p-dropdown{border-radius: 0 !important; }.EPF_form-element:focus{ -webkit-box-shadow: none !important; box-shadow:none !important; background-color: transparent !important; border-color: #4A4A4A !important;}.EPF_form-element--error{ -webkit-box-shadow: none !important; box-shadow:none !important; background-color: transparent !important; border-color: #DC143C !important;}.EPF_form-element--error:focus{background-color: #F6CCD1 !important; }.has-error .form-control{ -webkit-box-shadow: none !important; box-shadow:none !important; background-color: transparent !important;}.has-error .form-control:focus{ -webkit-box-shadow: none !important; box-shadow:none !important; background-color: transparent !important;}.EPF__form-element{color: rgb(255, 255, 255); }.p-inputtext{color: rgb(255, 255, 255)}.EPF__form-element::placeholder{color: rgb(255, 255, 255)}"

ThemeFontsstring[] · max: 50 · nullableOptional

optional - Array of fonts to be used in the session. example: ""Open Sans:400,500,600,700 ","Montserrat:400, 700 ","Roboto:400, 700 ".

FirstNamestring · max: 50 · nullableOptional

optional (max: 50) - if set, this FirstName will display in payment form

LastNamestring · max: 50 · nullableOptional

optional (max: 50) - if set, this LastName will display in payment form

Emailstring · email · max: 100 · nullableOptional

option (max: 100) - valid contact email - - if set, this Email will display in payment form

Streetstring · max: 50 · nullableOptional

optional (max: 50) - if set, this Street will display in payment form

Citystring · max: 50 · nullableOptional

optional (max: 50) - if set, this City will display in payment form

Zipstring · max: 10 · nullableOptional

optional (max: 10) - US, CA, AU formats are validated (example formats - US: 12345 or 12345-1234, CA: A1A 1A1, AU: 3000 - if set, this Zip will display in payment form

Statestring · max: 50 · nullableOptional

optional - 2 char US state code, 3 char may be used for other non-US - if set, this State will display in payment form

Countrystring · max: 2 · nullableOptional

optional - 2 char country code - if set, this Country will display in payment form

Phonestring · max: 20 · nullableOptional

optional (max: 20) - valid North America and AU patterns currently supported: 123-456-7890, [phone], 123.456.7890, [phone], 1234567890, 0412345678, [phone]

TokenizeCardboolean · nullableOptional

optional - set to true to tokenize card or check at time of purchase

TokenGuidstring · nullableOptional

optional - TokenGuid to use to process transaction in payment form. If using ExternalCardToken or ExternalCheckToken instead of TokenGuid - Valid Token Guid from a Tokenized card through Embedded Payment Form/Payment API

ExternalCardTokenstring · max: 200 · nullableOptional

optional (max: 200) - Customer credit card token generated outside the Embedded Form (e.g. ArgoFire). ExternalCardToken to use to process transaction in payment form.

ExternalCheckTokenstring · max: 200 · nullableOptional

optional (max: 200) - Customer check token generated outside the Embedded Form (e.g. ArgoFire). ExternalCheckToken to use to process transaction in payment form.

ExternalEventIdstring · max: 10 · nullableOptional

optional (max: 10) - Customer Event Id

ExternalEventNamestring · max: 500 · nullableOptional

optional (max: 500) - Customer Event Name

Responses

200

Returns a pay link

application/json

PayLinkUrlstring · nullableOptional

a unique URL that when clicked, direct users to our FrontStream secure online payment page

400

If pay link creation throws exception

application/json

404

If pay link data is not found

application/json

post

/api/paylink

HTTPcURLJavaScriptPython

POST /api/paylink HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 709

{
  "ApiKey": "text",
  "ProcessorGuid": "text",
  "IntegrationSource": "text",
  "IpAddress": "text",
  "RedirectUrl": "text",
  "PaymentLines": [
    {
      "Amount": "text",
      "Type": 1,
      "Recurring": 1,
      "ExternalLineId": "text"
    }
  ],
  "TranId": "text",
  "ShowTransactionId": true,
  "TransactionIdText": "text",
  "PoweredByText": "text",
  "PoweredByUrl": "text",
  "DonateButtonText": "text",
  "Language": "text",
  "DefaultCountryCode": "text",
  "Theme": "text",
  "ThemeFonts": [
    "text"
  ],
  "FirstName": "text",
  "LastName": "text",
  "Email": "[e-mail]",
  "Street": "text",
  "City": "text",
  "Zip": "text",
  "State": "text",
  "Country": "text",
  "Phone": "text",
  "TokenizeCard": true,
  "TokenGuid": "text",
  "ExternalCardToken": "text",
  "ExternalCheckToken": "text",
  "ExternalEventId": "text",
  "ExternalEventName": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "PayLinkUrl": "text"
}

Delete/Cancel a previous pay link url created from being used again

delete

Query parameters

PayLinkIdstringRequired

required - Valid pay link identifier to be cancelled/deleted - the identifier is the last parameter of the pay link url returned in the original creation process

IntegrationSourcestringOptional

internal use - Identifies integrated Product

Header parameters

AccessTokenstringRequired

access token

Responses

200

Success

application/json

PayLinkUrlstring · nullableOptional

a unique URL that when clicked, direct users to our FrontStream secure online payment page

400

Failure

application/json

delete

/api/paylink

HTTPcURLJavaScriptPython

DELETE /api/paylink?PayLinkId=text HTTP/1.1
AccessToken: text
Accept: */*

{
  "PayLinkUrl": "text"
}