POST /storefront/payment-instruments/{id}/setup

Creates a setup payment instrument transaction.

This operation makes the payment instrument available for further payments. Treat the response as a regular transaction. For example, approval links must be followed until the transaction is completed.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`amount`	Number	No	Amount of the transaction. Default value: 0
`redirectUrl`	String	No	URL to redirect the end-user when an offsite transaction is completed. This field defaults to the configured website URL. You may use `{id}` or `{result}` as placeholders in the URL. These placeholders are replaced with the transaction ID and result. For more information, see Placeholders.
`riskMetadata`	Object	No	Risk metadata used for 3D Secure and risk scoring.
`riskMetadata.hasMismatchedHolderName`	Boolean	No	Specifies if the customer's billing address name and primary address name are not the same.
`riskMetadata.score`	Integer	No	Computed risk score based on IP risk data, such as: `isVpn`, `isTor`, and `isProxy`.
`riskMetadata.emailVelocity`	Integer	No	Number of transactions for this email address in the last 24 hours.
`riskMetadata.httpHeaders`	Object	No
`riskMetadata.hasMismatchedBillingAddressCountry`	Boolean	No	Specifies if the customer's billing address country and geo-IP address are not the same.
`riskMetadata.declinedPaymentInstrumentVelocity`	Integer	No	Number of declined transactions for this payment instrument fingerprint in the last 24 hours.
`riskMetadata.accuracyRadius`	Integer	No	Accuracy radius of the specified IP address, in kilometers.
`riskMetadata.latitude`	Number	No	Latitude of the specified IP address.
`riskMetadata.isHosting`	Boolean	No	Specifies if the customer's IP address is related to hosting.
`riskMetadata.city`	String	No	City of the specified IP address.
`riskMetadata.extraData`	Object	No	Third-party data used for risk scoring.
`riskMetadata.extraData.payPalMerchantSessionId`	String	No	PayPal `MerchantSessionID` as generated by the PayPal Fraudnet SDK.
`riskMetadata.extraData.threatMetrixSessionId`	String	No	Temporary identifier that is unique to the visitor session and passed to ThreatMetrix.
`riskMetadata.extraData.kountFraudSessionId`	String	No	Alpha-numeric `fraudSessionId` as provided by the Kount SDK.
`riskMetadata.isProxy`	Boolean	No	Specifies if the customer's IP address is related to a proxy.
`riskMetadata.postalCode`	String	No	Postal code of the specified IP address.
`riskMetadata.paymentInstrumentApprovedTransactionCount`	Integer	No	Number of approved transactions for this payment instrument.
`riskMetadata.longitude`	Number	No	Longitude of the specified IP address.
`riskMetadata.hasMismatchedTimeZone`	Boolean	No	Specifies if the customer's browser time zone and the IP address associated time zone are not the same.
`riskMetadata.distance`	Integer	No	Distance between the customer's IP address and the billing address geolocation, in kilometers.
`riskMetadata.country`	String	No	Country ISO Alpha-2 code of the specified IP address.
`riskMetadata.paymentInstrumentVelocity`	Integer	No	Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours.
`riskMetadata.hostingName`	String	No	Name of the data center or hosting provider, if available.
`riskMetadata.region`	String	No	Region of the specified IP address.
`riskMetadata.hasMismatchedBankCountry`	Boolean	No	Specifies if the customer's bank country and geo-IP address are not the same.
`riskMetadata.browserData`	Object	No	Browser data used for 3D Secure and risk scoring.
`riskMetadata.browserData.isJavaEnabled`	Boolean	Yes	Specifies if Java is enabled in a browser. This value is obtained from the `navigator.javaEnabled` property.
`riskMetadata.browserData.isAdBlockEnabled`	Boolean	No	Specifies if the usage of ad block has been detected in the browser.
`riskMetadata.browserData.screenWidth`	Integer	Yes	Width of the browser screen. This value is obtained from the `screen.width` property.
`riskMetadata.browserData.timeZoneOffset`	Integer	Yes	Browser time zone offset in minutes from UTC. A positive offset indicates that the local time is behind UTC. A negative offset indicates that the local time is ahead of UTC. You can find this value using the `(new Date()).getTimezoneOffset()` property.
`riskMetadata.browserData.screenHeight`	Integer	Yes	Height of the browser screen. This value is obtained from the `screen.height` property.
`riskMetadata.browserData.colorDepth`	Integer	Yes	Browser color depth in bits per pixel. This value is obtained using the `screen.colorDepth` property.
`riskMetadata.browserData.language`	String	Yes	Browser language settings. This value is obtained from the `navigator.language` property.
`riskMetadata.isVpn`	Boolean	No	Specifies if the customer's IP address is related to a VPN.
`riskMetadata.fingerprint`	String	No	Customer's device fingerprint. A device fingerprint is a unique token that is used to identify the customer. The device fingerprint is generated based on device attributes, such as: hardware, software, IP address, language, browser, and more.
`riskMetadata.ipAddress`	String	No	Customer's IP address.
`riskMetadata.billingAddressVelocity`	Integer	No	Number of transactions for this billing address in the last 24 hours.
`riskMetadata.deviceVelocity`	Integer	No	Number of transactions for this device, based on fingerprint, in the last 24 hours.
`riskMetadata.ipVelocity`	Integer	No	Number of transactions for this IP address in the last 24 hours.
`riskMetadata.isp`	String	No	Internet Service Provider (ISP) name, if available.
`riskMetadata.hasFakeName`	Boolean	No	Specifies if the holder name seems fake.
`riskMetadata.timeZone`	String	No	Time zone of the specified IP address.
`riskMetadata.isTor`	Boolean	No	Specifies if the customer's IP address is related to TOR.
`riskMetadata.isHighRiskCountry`	Boolean	No	Specifies if the geo-IP country, or the customer's billing country, is considered a high risk country.
`billingAddress`	Object	No	Billing address. If a billing address is not supplied the address associated with the payment instrument is used. If no address is associated with the payment instrument, the customer's address is used.
`currency`	String	Yes	Currency code in ISO 4217 format.
`websiteId`	String	Yes	ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.