Pay Links
Returns a pay link - a unique URL that when clicked, directs users to our FrontStream secure online payment page
access token
required - Your API key for pay link authentication.
optional - Identifies Processor being used by an API Partner
optional and internal use - Identifies integrated Product
client ip address where transaction originates
required - The URL to which the user will be redirected after payment.
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
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
optional (max: 100) - The text to display in front of the TranId. Example: Invoice#:
optional (max: 100) - Text to display for branding purposes (e.g., "Powered by Your Company"). If not provided, defaults to the Integration Source Application name configured that created the Pay link. Otherwise, defaults to "FrontStream"
optional (max: 500) - a valid URL users will be directed to when clicking the PoweredByText usually your Company URL. If not provided, defaults to https://www.frontstream.com
optional (max: 100) - Text displayed on the submit payment button. Default is "Submit Payment".
optional (max: 35) - The language of the pay link session. Default is "en" for english.
optional - 2 char country code. The default country code for user input. Example: "US".
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)}"
optional - Array of fonts to be used in the session. example: ""Open Sans:400,500,600,700 ","Montserrat:400, 700 ","Roboto:400, 700 ".
optional (max: 50) - if set, this FirstName will display in payment form
optional (max: 50) - if set, this LastName will display in payment form
option (max: 100) - valid contact email - - if set, this Email will display in payment form
optional (max: 50) - if set, this Street will display in payment form
optional (max: 50) - if set, this City will display in payment form
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
optional - 2 char US state code, 3 char may be used for other non-US - if set, this State will display in payment form
optional - 2 char country code - if set, this Country will display in payment form
optional (max: 20) - valid North America and AU patterns currently supported: 123-456-7890, (123) 456-7890, 123.456.7890, +12025550123, 1234567890, 0412345678, +61412345678
optional - set to true to tokenize card or check at time of purchase
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
optional (max: 200) - Customer credit card token generated outside the Embedded Form (e.g. ArgoFire). ExternalCardToken can be used to process transaction in payment form.
optional (max: 200) - Customer check token generated outside the Embedded Form (e.g. ArgoFire). ExternalCheckToken can be used to process transaction in payment form.
optional (max: 10) - Customer Event Id
optional (max: 500) - Customer Event Name
optional - future use - Workflow type for the session. Valid values: 3 (TokenPayment), 4 (ManageTokens). Use 3 to tokenize a card for an existing constituent without processing a payment. Use 4 for full card wallet management (list, add, delete).
optional (max: 200) - The merchant's internal customer/client ID. This links the new card token to the customer/client's existing processor customer record.
optional (max: 200) - The 3rd party gateway Customer Key for a pre-existing customer record without a Payment API token record. When provided with ExternalConstituentId, links the payment session to the existing processor customer record instead of creating a new one.
Returns a pay link
a unique URL that when clicked, direct users to our FrontStream secure online payment page
If pay link creation throws exception
If pay link data is not found
POST /api/paylink HTTP/1.1
AccessToken: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 785
{
"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": "name@gmail.com",
"Street": "text",
"City": "text",
"Zip": "text",
"State": "text",
"Country": "text",
"Phone": "text",
"TokenizeCard": true,
"TokenGuid": "text",
"ExternalCardToken": "text",
"ExternalCheckToken": "text",
"ExternalEventId": "text",
"ExternalEventName": "text",
"WorkflowType": 1,
"ExternalConstituentId": "text",
"ExternalCustomerId": "text"
}{
"PayLinkUrl": "text"
}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
internal use - Identifies integrated Product
access token
Success
a unique URL that when clicked, direct users to our FrontStream secure online payment page
Failure
DELETE /api/paylink?PayLinkId=text HTTP/1.1
AccessToken: text
Accept: */*
{
"PayLinkUrl": "text"
}Last updated