Sign up a card via an iframe

Use this call to render an iframe into your website. After it's been added to your website, payee card information can be entered directly into the iframe.

POST /api/iFrameConfigurationBuildSignupCardUrl

Sample request

{
  "requestId": "00000000-0000-0000-0000-000000000000",
  "customerReferenceNumber": "string",
  "domain": "string",
  "successContinueNavigationPoint": "string",
  "failureContinueNavigationPoint": "string",
  "firstName": "string",
  "lastName": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "state": "string",
  "countryCode": "string",
  "zipCode": "string",
  "email": "string",
  "phoneNumber": "string",
  "showOptionalFields": true
}

Attributes

Attribute

Description

requestId
string

A customer generated unique ID.
Required

customerReferenceNumber
string

Customer's reference number.
Required

domain
string

The domain in which the iframe will be used.
Required

successContinueNavigationPoint
string

The landing page for a successful result.
Optional

failureContinueNavigationPoint
string

The landing page for a failed result.
Optional

firstName
string

Cardholder's first name.
Optional

lastName
string

Cardholder's last name.
Optional

address1
string

Cardholder's address, line 1.
Optional

address2
string

Cardholder's address, line 2.
Optional

city
string

Cardholder's city.
Optional

state
string

Cardholder's State.
Optional

countryCode
string

2 letter country code.
Optional

zipCode
string

Zip code of residence.
Optional

email
string

Email address.
Optional

phoneNumber
string

Cardholder's phone number.
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",
  "isSuccessfull": true
}

Did this page help you?