POST
/
api
/
{productId}
Submit card and customer info for a product
curl --request POST \
  --url https://test.paysight.io/api/{productId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "paysightSession": "<string>",
  "partnerSession": "<string>",
  "card": {
    "name": "<string>",
    "pan": "<string>",
    "expiryMonth": 123,
    "expiryYear": 123,
    "cvv": "<string>",
    "bin": "<string>",
    "lastFour": "<string>",
    "brand": "<string>"
  },
  "email": "<string>",
  "phone": "<string>",
  "address": {
    "firstName": "<string>",
    "lastName": "<string>",
    "street": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "shippingAddress": {
    "firstName": "<string>",
    "lastName": "<string>",
    "street": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "amount": 123,
  "mid": "<string>",
  "props": {},
  "campaignId": 123,
  "affiliateId": 123,
  "campaignName": "<string>",
  "affiliateName": "<string>",
  "subAffiliate": "<string>",
  "trackhouseClickId": "<string>",
  "threeDSecure": {
    "Enabled": true,
    "AfterAuthorization": true,
    "SkipChallenge": true,
    "ProceedDespiteFailure": true
  },
  "useragent": "<string>",
  "ip": "<string>",
  "cascade": true
}'
{
  "paysightSession": "<string>",
  "partnerSession": "<string>",
  "subscribeSuccess": true,
  "chargeSuccess": true,
  "info": "<string>",
  "error": "<string>",
  "email": "<string>",
  "message": "<string>",
  "orderId": 123,
  "descriptor": "<string>",
  "mid": "<string>",
  "threeDSecureId": "<string>",
  "transactionId": "<string>",
  "amount": 123,
  "statusId": 123,
  "declineSalvage": true
}

Authorizations

​
Authorization
string
header
required

This will be provided by Paysight

Path Parameters

​
productId
integer
required

ID of the Paysight product. This can be found at https://app.paysight.io/management/products

Body

application/json
​
card
object
required
​
email
string
required

Customer email address

​
amount
number
required

Amount to charge in the transaction

​
paysightSession
string

Unique session identifier from Paysight. Either this or partnerSession must be provided.

​
partnerSession
string

Session identifier from the partner's system. Either this or paysightSession must be provided.

​
phone
string

Customer phone number

​
address
object
​
shippingAddress
object
​
mid
string

Override to explicitly set for the transaction. It will override the Paysight logic for selecting the MID. Omit by default.

​
props
object

Custom metadata as key-value pairs

​
campaignId
integer

Paysight assigned ID of the campaign. Please set as 0 (or omit) unless you have the appropriate Paysight value

​
affiliateId
integer

Paysight assigned ID of the traffic source / affiliate. Please set as 0 (or omit) unless you have the appropriate Paysight value

​
campaignName
string

Name (or alias or your identifier) of your campaign. If campaignId is 0 and this value is provided, Paysight will auto-assign or auto-create (if new value) the campaign record

​
affiliateName
string

Name (or alias or your identifier) of your affiliate/traffic source. If affiliateId is 0 and this value is provided, Paysight will auto-assign or auto-create (if new value) the affiliate (traffic source) record

​
subAffiliate
string

Sub-affiliate identifier, if applicable. This can be passed in the format 'primarysubid_secondarysubId' (or simply primarysubid if no secondary source is present). These fields are available as breakdowns in Reporting as Primary Sub ID and Secondary Sub ID

​
trackhouseClickId
string

Tracking click ID from Trackhouse. Not required

​
threeDSecure
object
​
useragent
string

User-Agent header from client request

​
ip
string

IP address of the client

​
cascade
boolean

If true, will attempt a cascade, i.e. a second authorization attempt on another MID if selection conditions are met

Response

200 - application/json

Card submission result

​
paysightSession
string

Paysight session identifier

​
partnerSession
string

Partner session identifier

​
subscribeSuccess
boolean

Indicates if the subscription succeeded

​
chargeSuccess
boolean

Indicates if the charge transaction succeeded, ie was fully captured.

​
info
string

Additional informational message

​
error
string

Error message, if any

​
email
string

Email address associated with the transaction

​
message
string

General message about the result

​
orderId
integer

Order identifier

​
descriptor
string

Credit card descriptor that will appear on the statement

​
mid
string

Merchant ID used for the transaction

​
threeDSecureId
string

Identifier for the 3D Secure attempt

​
transactionId
string

Transaction ID from the processor

​
amount
number

Amount charged

​
statusId
number

The Paysight Status identifier

​
declineSalvage
boolean

Indicates if the user was subscribed even though the transaction was declined. e.g due to Insufficient funds