Add iframes to your site

Use this call to add an iframe into your website. After you've added it to your website, payee's can enter their card information via the iframe.

POST /api/iFrameConfigurationBuildSignupCardUrl

{
  "requestId": "24jla71k-fjl1-08m8-bks7-naxk8773bxr4",
  "customerReferenceNumber": <reference number>,
  "domain": www....com,
  "successContinueNavigationPoint": "www.....com",
  "failureContinueNavigationPoint": "www.....com",
  "firstName": Jana,
  "lastName": Parker,
  "address1": 257 Dalton Groves,
  "address2": null,
  "city": Barton City",
  "state": MI,
  "countryCode": US,
  "zipCode": 48705,
  "email": <[email protected]>,
  "phoneNumber": null,
}

Attributes for building the iframe

Attribute	Description
requestId string	Unique customer generated request ID. Required
customerReferenceNumber string	4-digit code merchant assigns. Required
domain string	The domain in which the iframe will be used. Required
successContinueNavigationPoint string	The landing page the customer is directed to if the sign up was successful. Optional
failureContinueNavigationPoint string	The landing page the customer is directed to if the sign up was unsuccessful and failed. Optional
firstName string	First name. Optional
lastName string	Last name. Optional
address1 string	Address, line 1. Optional
address2 string	Address, line 2. Optional
city string	City. Optional
state string	State. Optional
countryCode string	2 letter country code. Optional
zipCode string	Zip code. Optional
email string	Email address. Optional
phoneNumber string	Phone number. No dashes required. Optional
showOptionalFields boolean	Indicates if optional fields can be viewed. True if optional fields can be viewed, otherwise false. Optional

Sample response

{
  "version": "1.0.0.0",
  "result": "Success",
  "isSuccessful": true
}

Attribute	Description
`result`	Result of whether or not the source URL was added to our server. - Success - Authorization Failure
`isSuccessful`	True if a unique URL was built successfully, otherwise false.