Purchases

Transactions that have been executed related to the purchase of goods or services.

Perform a payment

Perform a payment for a transaction or an invoice.

If Customer JWT contains transactionId or invoiceId it will be used instead. transactionId has a higher priority than invoiceId.

SecurityCustomerJWT or PublishableApiKey

Request

Request Body schema: application/json

One of:

token

required

string

Payment token ID.

transactionId

required

string (ResourceId) <= 50 characters

The resource ID. Defaults to UUID v4.

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

ipAddress

string <ipv4 or ipv6>

The customer's IP.

fingerprint

string <= 50 characters

The fingerprint.

object (HttpHeaders)

The HTTP headers.

property name*

additional property

string

object (Browser data)

Browser data used for 3DS and risk scoring.

colorDepth required	integer [ 1 .. 48 ] The browser's color depth in bits per pixel obtained using the `screen.colorDepth` property.
isJavaEnabled required	boolean Whether Java is enabled in a browser or not. Value is returned from the `navigator.javaEnabled` property.
language required	string <= 8 characters The browser's language settings returned from the `navigator.language` property.
screenWidth required	integer [ 0 .. 65535 ] The browser's screen width returned from the `screen.width` property.
screenHeight required	integer [ 0 .. 65535 ] The browser's screen height returned from the `screen.height` property.
timeZoneOffset required	integer [ -1410 .. 1410 ] The browser's time zone offset in minutes from UTC. A positive offset indicates the local time is behind UTC, and negative is ahead. Can find it with `(new Date()).getTimezoneOffset()` property.

object (Extra data)

Third party data used for risk scoring.

kountFraudSessionId	string [ 10 .. 32 ] Alpha-numeric fraudSessionId as provided by the Kount SDK.
payPalMerchantSessionId	string [ 1 .. 64 ] MerchantSessionID as generated by the PayPal Fraudnet SDK.
threatMetrixSessionId	string [ 1 .. 128 ] [a-zA-Z0-9_-]+ A temporary identifier that is unique to the visitor's session and passed to ThreatMetrix.

redirectUrl

string or null <url> (StorefrontTransactionRedirectUrl)

The URL to redirect the end-user when an offsite transaction is completed. If website.url is https://example.com, then the redirectUrl could be set to any of these:

https://example.com
https://example.com/some/path
https://example.com/some/path?and=query
https://example.com/some/path?and=query#and-fragment

Defaults to the website's configured URL. You may use {id} or {result} as placeholders in the URL and we will replace them with the transaction's id and result accordingly.

Responses

200

Transaction was created.

Response Schema: application/json

string <= 50 characters

The resource ID. Defaults to UUID v4.

websiteId

string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId

string <= 50 characters

The resource ID. Defaults to UUID v4.

type

string

Transaction type.

Enum: "3ds-authentication" "authorize" "capture" "credit" "refund" "sale" "setup" "void"

status

string

Transaction status.

Enum: "completed" "conn-error" "disputed" "never-sent" "offsite" "partially-refunded" "pending" "refunded" "sending" "suspended" … 6 more

result

string

Transaction result.

Enum: "abandoned" "approved" "canceled" "declined" "unknown"

amount

number <double>

The transaction's amount.

currency

string = 3 characters

ISO 4217 alphabetic currency code.

purchaseAmount

number <double>

The amount actually purchased which may have differed from the originally requested amount in case of an adjustment.

purchaseCurrency

string = 3 characters

ISO 4217 alphabetic currency code.

requestAmount

number <double>

The amount in the payment request. If adjusted, the purchase amount and billing amount may vary from it.

requestCurrency

string = 3 characters

ISO 4217 alphabetic currency code.

parentTransactionId

string <= 50 characters

The resource ID. Defaults to UUID v4.

childTransactions

Array of strings (ResourceId)

The child transaction IDs.

invoiceIds

Array of strings (ResourceId)

The invoice IDs related to transaction.

subscriptionIds

Array of strings (ResourceId)

The orders IDs related to transaction's invoice(s).

planIds

Array of strings (ResourceId)

The plan IDs related to transaction's order(s).

isRebill

boolean

rebillNumber

integer

The transaction's rebill number.

object (InstrumentReference)

method required	string (PaymentMethod) The payment method. Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
paymentInstrumentId	string <= 50 characters The resource ID. Defaults to UUID v4.

object

Billing address.

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

hash

string <= 40 characters

A hash that can be used to compare multiple contacts for identical attribute values.

has3ds

boolean

object

server	string 3D Secure server name.
version	string 3D Secure version. Enum: "1.0.2" "2.1.0" "2.2.0"
enrolled	string Is the cardholder enrolled in 3D Secure. Enum: "yes" "no" "invalid card/timeout" "unavailable"
authenticated	string 3D Secure authentication response status. Enum: "yes" "no" "not applicable" "attempted"
liability	string Enum: "protected" "not protected" "protected (attempt)"
flow	string 3D Secure 2 authentication flow. Enum: "frictionless" "challenge"
isDowngraded	boolean Default: false If 3D Secure 2 was attempted but downgraded to 3D Secure 1.

redirectUrl

string <uri>

The URL to redirect the end-user when an offsite transaction is completed. Defaults to the website's configured URL.

retryNumber

integer

The position in the sequence of retries.

isRetry

boolean

True if this transaction is retry.

billingDescriptor

string

The billing descriptor that appears on the periodic billing statement. Commonly 12 or fewer characters for a credit card statement.

description

string <= 255 characters

The payment description.

requestId

string

The transaction's request ID. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.

hasAmountAdjustment

boolean

True if transaction has amount adjustment.

gatewayName

string

The payment gateway name.

Enum: "A1Gateway" "ACI" "Adyen" "Airpay" "AmazonPay" "AmexVPC" "ApcoPay" "AsiaPaymentGateway" "AstroPayCard" "AuthorizeNet" … 164 more

customFields

object (ResourceCustomFields)

Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

processedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

createdTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

approvalUrl

string <uri>

The URL to redirect the end-customer when transaction status is waiting-approval or offsite.

token

string

The session's token used for authentication. It would allow to visit created order, invoice and transaction.

Array of SelfLink (object) or ApprovalUrlLink (object) non-empty

The links related to resource.

Array (non-empty)

Any of:

rel required	string The link type. Value: "self"
href required	string The link URL.

201

Transaction was updated.

Response Schema: application/json

string <= 50 characters

The resource ID. Defaults to UUID v4.

websiteId

string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId

string <= 50 characters

The resource ID. Defaults to UUID v4.

type

string

Transaction type.

Enum: "3ds-authentication" "authorize" "capture" "credit" "refund" "sale" "setup" "void"

status

string

Transaction status.

Enum: "completed" "conn-error" "disputed" "never-sent" "offsite" "partially-refunded" "pending" "refunded" "sending" "suspended" … 6 more

result

string

Transaction result.

Enum: "abandoned" "approved" "canceled" "declined" "unknown"

amount

number <double>

The transaction's amount.

currency

string = 3 characters

ISO 4217 alphabetic currency code.

purchaseAmount

number <double>

The amount actually purchased which may have differed from the originally requested amount in case of an adjustment.

purchaseCurrency

string = 3 characters

ISO 4217 alphabetic currency code.

requestAmount

number <double>

The amount in the payment request. If adjusted, the purchase amount and billing amount may vary from it.

requestCurrency

string = 3 characters

ISO 4217 alphabetic currency code.

parentTransactionId

string <= 50 characters

The resource ID. Defaults to UUID v4.

childTransactions

Array of strings (ResourceId)

The child transaction IDs.

invoiceIds

Array of strings (ResourceId)

The invoice IDs related to transaction.

subscriptionIds

Array of strings (ResourceId)

The orders IDs related to transaction's invoice(s).

planIds

Array of strings (ResourceId)

The plan IDs related to transaction's order(s).

isRebill

boolean

rebillNumber

integer

The transaction's rebill number.

object (InstrumentReference)

method required	string (PaymentMethod) The payment method. Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
paymentInstrumentId	string <= 50 characters The resource ID. Defaults to UUID v4.

object

Billing address.

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

hash

string <= 40 characters

A hash that can be used to compare multiple contacts for identical attribute values.

has3ds

boolean

object

server	string 3D Secure server name.
version	string 3D Secure version. Enum: "1.0.2" "2.1.0" "2.2.0"
enrolled	string Is the cardholder enrolled in 3D Secure. Enum: "yes" "no" "invalid card/timeout" "unavailable"
authenticated	string 3D Secure authentication response status. Enum: "yes" "no" "not applicable" "attempted"
liability	string Enum: "protected" "not protected" "protected (attempt)"
flow	string 3D Secure 2 authentication flow. Enum: "frictionless" "challenge"
isDowngraded	boolean Default: false If 3D Secure 2 was attempted but downgraded to 3D Secure 1.

redirectUrl

string <uri>

The URL to redirect the end-user when an offsite transaction is completed. Defaults to the website's configured URL.

retryNumber

integer

The position in the sequence of retries.

isRetry

boolean

True if this transaction is retry.

billingDescriptor

string

The billing descriptor that appears on the periodic billing statement. Commonly 12 or fewer characters for a credit card statement.

description

string <= 255 characters

The payment description.

requestId

string

The transaction's request ID. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.

hasAmountAdjustment

boolean

True if transaction has amount adjustment.

gatewayName

string

The payment gateway name.

Enum: "A1Gateway" "ACI" "Adyen" "Airpay" "AmazonPay" "AmexVPC" "ApcoPay" "AsiaPaymentGateway" "AstroPayCard" "AuthorizeNet" … 164 more

customFields

object (ResourceCustomFields)

Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

processedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

createdTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

approvalUrl

string <uri>

The URL to redirect the end-customer when transaction status is waiting-approval or offsite.

token

string

The session's token used for authentication. It would allow to visit created order, invoice and transaction.

Array of SelfLink (object) or ApprovalUrlLink (object) non-empty

The links related to resource.

Array (non-empty)

Any of:

rel required	string The link type. Value: "self"
href required	string The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

post/payment

Request samples

application/json

{"transactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"riskMetadata": {"ipAddress": "93.92.91.90",
"fingerprint": "pIUt3xbgX3l9g3YDiLbx",
"httpHeaders": {"Content-Type": "application/json",
"Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
},
"browserData": {"colorDepth": 24,
"isJavaEnabled": true,
"language": "en-US",
"screenWidth": 1920,
"screenHeight": 1080,
"timeZoneOffset": 300
},
"extraData": {"kountFraudSessionId": "abcdefg12345abababab123456789012",
"payPalMerchantSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowa",
"threatMetrixSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"
}
},
"redirectUrl": "string",
"token": "string"
}

Response samples

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"type": "3ds-authentication",
"status": "completed",
"result": "abandoned",
"amount": 0,
"currency": "USD",
"purchaseAmount": 0,
"purchaseCurrency": "USD",
"requestAmount": 0,
"requestCurrency": "USD",
"parentTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"childTransactions": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"invoiceIds": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"subscriptionIds": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"planIds": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"isRebill": true,
"rebillNumber": 0,
"paymentInstrument": {"method": "payment-card",
"paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"billingAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO",
"hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
},
"has3ds": true,
"3ds": {"server": "string",
"version": "1.0.2",
"enrolled": "yes",
"authenticated": "yes",
"liability": "protected",
"flow": "frictionless",
"isDowngraded": false
},
"redirectUrl": "http://example.com",
"retryNumber": 0,
"isRetry": true,
"billingDescriptor": "string",
"description": "string",
"requestId": "string",
"hasAmountAdjustment": true,
"gatewayName": "A1Gateway",
"customFields": {"foo": "bar"
},
"processedTime": "2019-08-24T14:15:22Z",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"approvalUrl": "http://example.com",
"token": "string",
"_links": [{"rel": "self",
"href": "string"
}
]
}

Make a purchase

Purchase can be accomplished both with and without Authentication. Purchase via pre-created Payment Instrument is only available with Authentication. Use purchase preview before making an actual purchase.

SecurityCustomerJWT or PublishableApiKey

Request

Request Body schema: application/json

websiteId

required

string <= 50 characters

The resource ID. Defaults to UUID v4.

required

Payment Token (object) or Payment Instrument (object) or Payment Methods (object) or Payment Card (object) or (Bank Account (BBANType (object) or IBANType (object)))

The payment instruction to be used for purchasing.

One of:

The payment instruction to be used for purchasing.

token

required

string

Payment Token ID.

required

Array of objects non-empty

Array (non-empty)

planId required	string <= 50 characters The resource ID. Defaults to UUID v4.
quantity	integer Number of units of the product on the given plan.

object or null

The billing address.

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

object or null

The delivery address.

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

shippingRateId

string <= 50 characters

The resource ID. Defaults to UUID v4.

couponIds

Array of strings

The list of coupons applied to the order.

password

string or null

If set would be used to create customer account.

redirectUrl

string or null <url>

The URL to redirect the end-user when an offsite transaction is completed. If website.url is https://example.com, then the redirectUrl could be set to any of these:

https://example.com
https://example.com/some/path
https://example.com/some/path?and=query
https://example.com/some/path?and=query#and-fragment

Defaults to the website's configured URL. You may use {id} or {result} as placeholders in the URL and we will replace them with the transaction's id and result accordingly.

Responses

201

Order was created.

Response Schema: application/json

orderId

string <= 50 characters

The resource ID. Defaults to UUID v4.

object (StorefrontInvoice)

The initial invoice.

currency

required

string = 3 characters

ISO 4217 alphabetic currency code.

websiteId

required

string <= 50 characters

The resource ID. Defaults to UUID v4.

string <= 50 characters

The resource ID. Defaults to UUID v4.

invoiceNumber

integer

An auto-incrementing number based on the sequence of invoices for any particular customer.

subscriptionId

string <= 50 characters

The resource ID. Defaults to UUID v4.

amount

number <double>

The invoice's amount.

amountDue

number <double>

The invoice's due amount.

subtotalAmount

number <double>

The invoice's subtotal amount.

discountAmount

number <double>

The invoice's discounts amount.

object (Shipping)

Shipping settings.

calculator required	string Shipping calculator. manual
amount required	integer Shipping amount.

object (InvoiceTax)

Invoice taxes.

calculator required	string Tax calculator. manual
required	Array of objects Taxes applied to this invoice.
amount	integer A sum of all invoice taxes.

object

Invoice's billing address.

firstName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact first name.
lastName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact last name.
organization	string or null <= 255 characters ^[\w\s\-\pL,.'&]+$ The contact organization.
address	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address.
address2	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address (second line).
city	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact city.
region	string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact region (state).
country	string or null <= 2 characters ^[A-Z]{2}$ The contact country ISO Alpha-2 code.
postalCode	string or null <= 10 characters ^[\w\s\-]+$ The contact postal code.
	Array of objects (ContactPhoneNumbers) The list of phone numbers.
	Array of objects (ContactEmails) The list of emails.
dob	string or null <date> The contact's date of birth in ISO-8601 format (yyyy-mm-dd).
jobTitle	string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact's job title.
hash	string <= 40 characters A hash that can be used to compare multiple contacts for identical attribute values.

object

Invoice's delivery address.

firstName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact first name.
lastName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact last name.
organization	string or null <= 255 characters ^[\w\s\-\pL,.'&]+$ The contact organization.
address	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address.
address2	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address (second line).
city	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact city.
region	string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact region (state).
country	string or null <= 2 characters ^[A-Z]{2}$ The contact country ISO Alpha-2 code.
postalCode	string or null <= 10 characters ^[\w\s\-]+$ The contact postal code.
	Array of objects (ContactPhoneNumbers) The list of phone numbers.
	Array of objects (ContactEmails) The list of emails.
dob	string or null <date> The contact's date of birth in ISO-8601 format (yyyy-mm-dd).
jobTitle	string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact's job title.
hash	string <= 40 characters A hash that can be used to compare multiple contacts for identical attribute values.

poNumber

string or null

Purchase order number which will be displayed on the invoice.

notes

string

Notes for the customer which will be displayed on the invoice.

Array of objects (InvoiceItem)

Invoice items array.

Array

type required	string Invoice item's type. Enum: "debit" "credit"
unitPrice required	number <double> Invoice item's price.
id	string <= 50 characters The resource ID. Defaults to UUID v4.
description	string Invoice item's description.
quantity	integer Invoice item's quantity.
price	number <double> Invoice item's total price.
productId	string <= 50 characters The resource ID. Defaults to UUID v4.
discountAmount	number <double> Invoice item discount amount.
periodStartTime	string <date-time> Start time.
periodEndTime	string <date-time> End time.
periodNumber	integer Invoice item subscription order period number.
createdTime	string <date-time> Read-only timestamp, automatically assigned on back-end.
updatedTime	string <date-time> Read-only timestamp, automatically assigned on back-end.
	object Invoice item tax.
	Array of SelfLink (object) or ProductLink (object) non-empty The links related to resource.
	Array of ProductEmbed (object) or PlanEmbed (object) non-empty Any embedded objects available that are requested by the `expand` querystring parameter.

Array of objects

Discounts applied.

Array

couponId

string <= 50 characters

The resource ID. Defaults to UUID v4.

redemptionId

string <= 50 characters

The resource ID. Defaults to UUID v4.

amount

number <double>

Total amount that was discounted by this Coupon.

description

string

Discount description.

context

string (DiscountContext)

Default: "items"

The context in which the discount applies.

Enum:	Description
items	items (less discounts)
shipping	shipping (less discounts)
items-and-shipping	items and shipping (less discounts)

autopayScheduledTime

string <date-time>

Invoice autopay scheduled time.

autopayRetryNumber

integer >= 0

Default: 0

Invoice autopay retry number.

status

string

Invoice status.

Enum: "draft" "unpaid" "paid" "partially-paid" "past-due" "abandoned" "voided" "partially-refunded" "refunded" "disputed"

delinquentCollectionPeriod

integer

Delinquent collection period - difference between paidTime and dueTime in days.

collectionPeriod

integer

Collection period - difference between paidTime and issuedTime in days.

abandonedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

voidedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

paidTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

dueTime

string <date-time>

Invoice due time.

issuedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

createdTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

paymentFormUrl

string <url>

URL where the customer can be redirected to pay for the invoice with one of the methods which are available for this customer. It's an alternative to creating a new transaction with empty methods.

Array of objects (StorefrontTransaction)

Invoice transactions array.

Array

id	string <= 50 characters The resource ID. Defaults to UUID v4.
websiteId	string <= 50 characters The resource ID. Defaults to UUID v4.
customerId	string <= 50 characters The resource ID. Defaults to UUID v4.
type	string Transaction type. Enum: "3ds-authentication" "authorize" "capture" "credit" "refund" "sale" "setup" "void"
status	string Transaction status. Enum: "completed" "conn-error" "disputed" "never-sent" "offsite" "partially-refunded" "pending" "refunded" "sending" "suspended" … 6 more
result	string Transaction result. Enum: "abandoned" "approved" "canceled" "declined" "unknown"
amount	number <double> The transaction's amount.
currency	string = 3 characters ISO 4217 alphabetic currency code.
purchaseAmount	number <double> The amount actually purchased which may have differed from the originally requested amount in case of an adjustment.
purchaseCurrency	string = 3 characters ISO 4217 alphabetic currency code.
requestAmount	number <double> The amount in the payment request. If adjusted, the purchase amount and billing amount may vary from it.
requestCurrency	string = 3 characters ISO 4217 alphabetic currency code.
parentTransactionId	string <= 50 characters The resource ID. Defaults to UUID v4.
childTransactions	Array of strings (ResourceId) The child transaction IDs.
invoiceIds	Array of strings (ResourceId) The invoice IDs related to transaction.
subscriptionIds	Array of strings (ResourceId) The orders IDs related to transaction's invoice(s).
planIds	Array of strings (ResourceId) The plan IDs related to transaction's order(s).
isRebill	boolean
rebillNumber	integer The transaction's rebill number.
	object (InstrumentReference)
	object Billing address.
has3ds	boolean
	object
redirectUrl	string <uri> The URL to redirect the end-user when an offsite transaction is completed. Defaults to the website's configured URL.
retryNumber	integer The position in the sequence of retries.
isRetry	boolean True if this transaction is retry.
billingDescriptor	string The billing descriptor that appears on the periodic billing statement. Commonly 12 or fewer characters for a credit card statement.
description	string <= 255 characters The payment description.
requestId	string The transaction's request ID. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.
hasAmountAdjustment	boolean True if transaction has amount adjustment.
gatewayName	string The payment gateway name. Enum: "A1Gateway" "ACI" "Adyen" "Airpay" "AmazonPay" "AmexVPC" "ApcoPay" "AsiaPaymentGateway" "AstroPayCard" "AuthorizeNet" … 164 more
customFields	object (ResourceCustomFields) Default: {} Custom Fields list as a map `{"custom field name": "custom field value", ...}`. The format must follow the saved format (see Custom Fields section for the formats).
processedTime	string <date-time> Read-only timestamp, automatically assigned on back-end.
createdTime	string <date-time> Read-only timestamp, automatically assigned on back-end.
updatedTime	string <date-time> Read-only timestamp, automatically assigned on back-end.
approvalUrl	string <uri> The URL to redirect the end-customer when transaction `status` is `waiting-approval` or `offsite`.
token	string The session's token used for authentication. It would allow to visit created order, invoice and transaction.
	Array of SelfLink (object) or ApprovalUrlLink (object) non-empty The links related to resource.

Array of SelfLink (object) non-empty

The links related to resource.

Array (non-empty)

Any of:

rel required	string The link type. Value: "self"
href required	string The link URL.

object (StorefrontTransaction)

The initial transaction.

string <= 50 characters

The resource ID. Defaults to UUID v4.

websiteId

string <= 50 characters

The resource ID. Defaults to UUID v4.

customerId

string <= 50 characters

The resource ID. Defaults to UUID v4.

type

string

Transaction type.

Enum: "3ds-authentication" "authorize" "capture" "credit" "refund" "sale" "setup" "void"

status

string

Transaction status.

Enum: "completed" "conn-error" "disputed" "never-sent" "offsite" "partially-refunded" "pending" "refunded" "sending" "suspended" … 6 more

result

string

Transaction result.

Enum: "abandoned" "approved" "canceled" "declined" "unknown"

amount

number <double>

The transaction's amount.

currency

string = 3 characters

ISO 4217 alphabetic currency code.

purchaseAmount

number <double>

The amount actually purchased which may have differed from the originally requested amount in case of an adjustment.

purchaseCurrency

string = 3 characters

ISO 4217 alphabetic currency code.

requestAmount

number <double>

The amount in the payment request. If adjusted, the purchase amount and billing amount may vary from it.

requestCurrency

string = 3 characters

ISO 4217 alphabetic currency code.

parentTransactionId

string <= 50 characters

The resource ID. Defaults to UUID v4.

childTransactions

Array of strings (ResourceId)

The child transaction IDs.

invoiceIds

Array of strings (ResourceId)

The invoice IDs related to transaction.

subscriptionIds

Array of strings (ResourceId)

The orders IDs related to transaction's invoice(s).

planIds

Array of strings (ResourceId)

The plan IDs related to transaction's order(s).

isRebill

boolean

rebillNumber

integer

The transaction's rebill number.

object (InstrumentReference)

method required	string (PaymentMethod) The payment method. Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 155 more
paymentInstrumentId	string <= 50 characters The resource ID. Defaults to UUID v4.

object

Billing address.

firstName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact first name.
lastName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact last name.
organization	string or null <= 255 characters ^[\w\s\-\pL,.'&]+$ The contact organization.
address	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address.
address2	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address (second line).
city	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact city.
region	string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact region (state).
country	string or null <= 2 characters ^[A-Z]{2}$ The contact country ISO Alpha-2 code.
postalCode	string or null <= 10 characters ^[\w\s\-]+$ The contact postal code.
	Array of objects (ContactPhoneNumbers) The list of phone numbers.
	Array of objects (ContactEmails) The list of emails.
dob	string or null <date> The contact's date of birth in ISO-8601 format (yyyy-mm-dd).
jobTitle	string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact's job title.
hash	string <= 40 characters A hash that can be used to compare multiple contacts for identical attribute values.

has3ds

boolean

object

server	string 3D Secure server name.
version	string 3D Secure version. Enum: "1.0.2" "2.1.0" "2.2.0"
enrolled	string Is the cardholder enrolled in 3D Secure. Enum: "yes" "no" "invalid card/timeout" "unavailable"
authenticated	string 3D Secure authentication response status. Enum: "yes" "no" "not applicable" "attempted"
liability	string Enum: "protected" "not protected" "protected (attempt)"
flow	string 3D Secure 2 authentication flow. Enum: "frictionless" "challenge"
isDowngraded	boolean Default: false If 3D Secure 2 was attempted but downgraded to 3D Secure 1.

redirectUrl

string <uri>

The URL to redirect the end-user when an offsite transaction is completed. Defaults to the website's configured URL.

retryNumber

integer

The position in the sequence of retries.

isRetry

boolean

True if this transaction is retry.

billingDescriptor

string

The billing descriptor that appears on the periodic billing statement. Commonly 12 or fewer characters for a credit card statement.

description

string <= 255 characters

The payment description.

requestId

string

The transaction's request ID. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.

hasAmountAdjustment

boolean

True if transaction has amount adjustment.

gatewayName

string

The payment gateway name.

Enum: "A1Gateway" "ACI" "Adyen" "Airpay" "AmazonPay" "AmexVPC" "ApcoPay" "AsiaPaymentGateway" "AstroPayCard" "AuthorizeNet" … 164 more

customFields

object (ResourceCustomFields)

Default: {}

Custom Fields list as a map {"custom field name": "custom field value", ...}. The format must follow the saved format (see Custom Fields section for the formats).

processedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

createdTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime

string <date-time>

Read-only timestamp, automatically assigned on back-end.

approvalUrl

string <uri>

The URL to redirect the end-customer when transaction status is waiting-approval or offsite.

token

string

The session's token used for authentication. It would allow to visit created order, invoice and transaction.

Array of SelfLink (object) or ApprovalUrlLink (object) non-empty

The links related to resource.

Array (non-empty)

Any of:

rel required	string The link type. Value: "self"
href required	string The link URL.

token

string

The session's token used for authentication. It would allow to visit created order, invoice and transaction.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/purchase

Request samples

application/json

{"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"items": [{"planId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"quantity": 0
}
],
"billingAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO"
},
"deliveryAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO"
},
"shippingRateId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"paymentInstruction": {"token": "string"
},
"couponIds": ["string"
],
"password": "string",
"redirectUrl": "string"
}

Response samples

application/json

{"orderId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"invoice": {"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"invoiceNumber": 0,
"subscriptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"currency": "USD",
"amount": 0,
"amountDue": 0,
"subtotalAmount": 0,
"discountAmount": 0,
"shipping": {"calculator": "manual"
},
"tax": {"calculator": "manual",
"amount": 0
},
"billingAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO",
"hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
},
"deliveryAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO",
"hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
},
"poNumber": "PO123456",
"notes": "string",
"items": [{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"type": "debit",
"description": "string",
"unitPrice": 0,
"quantity": 0,
"price": 0,
"productId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"discountAmount": 0,
"periodStartTime": "2019-08-24T14:15:22Z",
"periodEndTime": "2019-08-24T14:15:22Z",
"periodNumber": 0,
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"tax": {"amount": 0,
"description": "string",
"rate": 0,
"stateAmount": 0.94,
"countyAmount": 0.04,
"cityAmount": 0,
"specialDistrictAmount": 0.38,
"jurisdictions": {"country": "US",
"state": "CA",
"county": "LOS ANGELES",
"city": "LOS ANGELES"
}
},
"_links": [{"rel": "self",
"href": "string"
}
],
"_embedded": [{"product": {"id": "membership",
"name": "Premium membership",
"unitLabel": "seat",
"description": "string",
"requiresShipping": false,
"options": [null
],
"customFields": {"foo": "bar"
},
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"taxCategoryId": "00000",
"accountingCode": "4010",
"_links": [null
]
}
}
]
}
],
"discounts": [{"couponId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"redemptionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"amount": 0,
"description": "string",
"context": "items"
}
],
"autopayScheduledTime": "2019-08-24T14:15:22Z",
"autopayRetryNumber": 0,
"status": "draft",
"delinquentCollectionPeriod": 0,
"collectionPeriod": 0,
"abandonedTime": "2019-08-24T14:15:22Z",
"voidedTime": "2019-08-24T14:15:22Z",
"paidTime": "2019-08-24T14:15:22Z",
"dueTime": "2019-08-24T14:15:22Z",
"issuedTime": "2019-08-24T14:15:22Z",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"paymentFormUrl": "string",
"transactions": [{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"type": "3ds-authentication",
"status": "completed",
"result": "abandoned",
"amount": 0,
"currency": "USD",
"purchaseAmount": 0,
"purchaseCurrency": "USD",
"requestAmount": 0,
"requestCurrency": "USD",
"parentTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"childTransactions": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"invoiceIds": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"subscriptionIds": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"planIds": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"isRebill": true,
"rebillNumber": 0,
"paymentInstrument": {"method": "payment-card",
"paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"billingAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO",
"hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
},
"has3ds": true,
"3ds": {"server": "string",
"version": "1.0.2",
"enrolled": "yes",
"authenticated": "yes",
"liability": "protected",
"flow": "frictionless",
"isDowngraded": false
},
"redirectUrl": "http://example.com",
"retryNumber": 0,
"isRetry": true,
"billingDescriptor": "string",
"description": "string",
"requestId": "string",
"hasAmountAdjustment": true,
"gatewayName": "A1Gateway",
"customFields": {"foo": "bar"
},
"processedTime": "2019-08-24T14:15:22Z",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"approvalUrl": "http://example.com",
"token": "string",
"_links": [{"rel": "self",
"href": "string"
}
]
}
],
"_links": [{"rel": "self",
"href": "string"
}
]
},
"transaction": {"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"type": "3ds-authentication",
"status": "completed",
"result": "abandoned",
"amount": 0,
"currency": "USD",
"purchaseAmount": 0,
"purchaseCurrency": "USD",
"requestAmount": 0,
"requestCurrency": "USD",
"parentTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"childTransactions": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"invoiceIds": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"subscriptionIds": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"planIds": ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"
],
"isRebill": true,
"rebillNumber": 0,
"paymentInstrument": {"method": "payment-card",
"paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
},
"billingAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO",
"hash": "056ae6d97c788b9e98b049ebafd7b229bf852221"
},
"has3ds": true,
"3ds": {"server": "string",
"version": "1.0.2",
"enrolled": "yes",
"authenticated": "yes",
"liability": "protected",
"flow": "frictionless",
"isDowngraded": false
},
"redirectUrl": "http://example.com",
"retryNumber": 0,
"isRetry": true,
"billingDescriptor": "string",
"description": "string",
"requestId": "string",
"hasAmountAdjustment": true,
"gatewayName": "A1Gateway",
"customFields": {"foo": "bar"
},
"processedTime": "2019-08-24T14:15:22Z",
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"approvalUrl": "http://example.com",
"token": "string",
"_links": [{"rel": "self",
"href": "string"
}
]
},
"token": "string"
}

Preview a purchase

Warning: The shipping part of this API will change to support multiple shipping methods.

SecurityCustomerJWT or PublishableApiKey

Request

Request Body schema: application/json

websiteId

required

string <= 50 characters

The resource ID. Defaults to UUID v4.

required

Array of objects non-empty

Array (non-empty)

planId required	string <= 50 characters The resource ID. Defaults to UUID v4.
quantity	integer Number of units of the product on the given plan.

object or null

The billing address.

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

object or null

The delivery address.

firstName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact first name.

lastName

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact last name.

organization

string or null <= 255 characters ^[\w\s\-\pL,.'&]+$

The contact organization.

address

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address.

address2

string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact street address (second line).

city

string or null <= 45 characters ^[\w\s\-\pL,.']+$

The contact city.

region

string or null <= 45 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact region (state).

country

string or null <= 2 characters ^[A-Z]{2}$

The contact country ISO Alpha-2 code.

postalCode

string or null <= 10 characters ^[\w\s\-]+$

The contact postal code.

Array of objects (ContactPhoneNumbers)

The list of phone numbers.

Array

label required	string <= 45 characters The phone label.
value required	string <= 50 characters The phone value.
primary	boolean True if phone is primary.

Array of objects (ContactEmails)

The list of emails.

Array

label required	string <= 45 characters The email label.
value required	string <email> <= 255 characters The email value.
primary	boolean True if email is primary.

dob

string or null <date>

The contact's date of birth in ISO-8601 format (yyyy-mm-dd).

jobTitle

string or null <= 255 characters ^[\w\s\-\/\pL,.#;:()']+$

The contact's job title.

couponIds

Array of strings

The list of coupons applied to the order.

shippingRateId

string <= 50 characters

The resource ID. Defaults to UUID v4.

Responses

200

Purchase preview was retrieved.

Response Schema: application/json

currency

string = 3 characters

ISO 4217 alphabetic currency code.

Array of objects

Purchase items array.

Array

type	string Type of the item. Enum: "debit" "credit"
description	string Description of the item.
unitPrice	number <double> Unit price of the item.
quantity	number <integer> The item total quantity.
price	number <double> The item total amount.
planId	string <= 50 characters The resource ID. Defaults to UUID v4.
productId	string <= 50 characters The resource ID. Defaults to UUID v4.

Array of objects (ShippingOption)

Available shipping rates.

Array

name required	string The shipping rate name.
price required	number <double> The shipping rate price - 0 is a valid value (for free).
currency required	string = 3 characters ISO 4217 alphabetic currency code.
id	string <= 50 characters The resource ID. Defaults to UUID v4.
descriptions	string The shipping rate description.

Array of objects

Taxes applied to this purchase.

Array

amount	number <double> Tax amount.
description	string Tax description.

Array of objects

Discounts applied to this purchase.

Array

couponId	string <= 50 characters The resource ID. Defaults to UUID v4.
amount	number Total amount that was discounted by this coupon.
description	string The discount description.

subtotalAmount

number <double>

The purchase's subtotal amount.

taxAmount

number <double>

The purchase's taxes amount.

shippingAmount

number <double>

The purchase's shipping amount. This property will likely change to support multiple shipping methods.

discountsAmount

number <double>

The purchase's discounts amount.

total

number <double>

The purchase's total amount.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/preview-purchase

Request samples

application/json

{"websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"items": [{"planId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"quantity": 0
}
],
"billingAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO"
},
"deliveryAddress": {"firstName": "Benjamin",
"lastName": "Franklin",
"organization": "Rebilly",
"address": "36 Craven St",
"address2": "string",
"city": "London",
"region": "London",
"country": "GB",
"postalCode": "WC2N 5NF",
"phoneNumbers": [{"label": "main",
"value": "512-710-1640",
"primary": true
}
],
"emails": [{"label": "main",
"value": "rebilly@example.com",
"primary": true
}
],
"dob": "1980-04-01",
"jobTitle": "CEO"
},
"couponIds": ["string"
],
"shippingRateId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}

Response samples

application/json

{"currency": "USD",
"lineItems": [{"type": "debit",
"description": "string",
"unitPrice": 49.95,
"quantity": 0,
"price": 0,
"planId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"productId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}
],
"shippingRates": [{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"name": "string",
"descriptions": "string",
"price": 0,
"currency": "USD"
}
],
"taxes": [{"amount": 0,
"description": "string"
}
],
"discounts": [{"couponId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"amount": 0,
"description": "string"
}
],
"subtotalAmount": 0,
"taxAmount": 0,
"shippingAmount": 0,
"discountsAmount": 0,
"total": 0
}

Ready to Pay

Get available payment methods for a specific transaction or a purchase.

The payment methods order shown to a customer SHOULD be the same as the order in the response.

The list of available methods is generated from available Gateway Accounts intersected with the last matched Rules Engine adjust-ready-to-pay action on ready-to-pay-requested event.

If there were no actions matched for the specific request, then all methods supported by the Gateway Accounts are sent.

To invert this behavior place an all-matching rule at the very end of the ready-to-pay-requested event in Rules Engine with an empty paymentMethods property of the adjust-ready-to-pay action.

If Ready to Pay is used with Transaction-scoped JWT all fields will be ignored except the riskMetadata.

SecurityPublishableApiKey

Request

Request Body schema: application/json

One of:

currency

required

string (CurrencyCode) = 3 characters

ISO 4217 alphabetic currency code.

amount

required

number <double>

The amount.

websiteId

required

string <= 50 characters

The resource ID. Defaults to UUID v4.

required

object (Risk metadata)

Risk metadata used for 3DS and risk scoring.

ipAddress

string <ipv4 or ipv6>

The customer's IP.

fingerprint

string <= 50 characters

The fingerprint.

object (HttpHeaders)

The HTTP headers.

property name*

additional property

string

object (Browser data)

Browser data used for 3DS and risk scoring.

colorDepth required	integer [ 1 .. 48 ] The browser's color depth in bits per pixel obtained using the `screen.colorDepth` property.
isJavaEnabled required	boolean Whether Java is enabled in a browser or not. Value is returned from the `navigator.javaEnabled` property.
language required	string <= 8 characters The browser's language settings returned from the `navigator.language` property.
screenWidth required	integer [ 0 .. 65535 ] The browser's screen width returned from the `screen.width` property.
screenHeight required	integer [ 0 .. 65535 ] The browser's screen height returned from the `screen.height` property.
timeZoneOffset required	integer [ -1410 .. 1410 ] The browser's time zone offset in minutes from UTC. A positive offset indicates the local time is behind UTC, and negative is ahead. Can find it with `(new Date()).getTimezoneOffset()` property.

object (Extra data)

Third party data used for risk scoring.

kountFraudSessionId	string [ 10 .. 32 ] Alpha-numeric fraudSessionId as provided by the Kount SDK.
payPalMerchantSessionId	string [ 1 .. 64 ] MerchantSessionID as generated by the PayPal Fraudnet SDK.
threatMetrixSessionId	string [ 1 .. 128 ] [a-zA-Z0-9_-]+ A temporary identifier that is unique to the visitor's session and passed to ThreatMetrix.

object

The billing address.

firstName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact first name.
lastName	string or null <= 45 characters ^[\w\s\-\pL,.']+$ The contact last name.
organization	string or null <= 255 characters ^[\w\s\-\pL,.'&]+$ The contact organization.
address	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address.
address2	string or null <= 60 characters ^[\w\s\-\/\pL,.#;:()']+$ The contact street address (second line).
city	string or null <=