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
.
Transaction was created.
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. | ||||||||||||||||||||||||||||||||
status | string Transaction status. | ||||||||||||||||||||||||||||||||
result | string Transaction result. | ||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||
Transaction was updated.
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. | ||||||||||||||||||||||||||||||||
status | string Transaction status. | ||||||||||||||||||||||||||||||||
result | string Transaction result. | ||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Invalid data was sent.
{- "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"
}
{- "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
}, - "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",
- "token": "string",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
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.
websiteId required | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||
required | object or object or object The payment instruction to be used for purchasing. | ||||||||||||||||||||||||||||||
required | Array of objects non-empty | ||||||||||||||||||||||||||||||
object or null The billing address. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object or null The delivery address. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
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
Defaults to the website's configured URL. You may use |
Order was created.
orderId | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (StorefrontInvoice) The initial invoice. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (StorefrontTransaction) The initial transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
token | string The session's token used for authentication. It would allow to visit created order, invoice and transaction. |
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "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"
}
{- "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
}, - "_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
}, - "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",
- "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
}, - "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",
- "token": "string",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}, - "token": "string"
}
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.
Warning: The shipping part of this API will change to support multiple shipping methods.
websiteId required | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||||||||||||||||||||||||||||
required | Array of objects non-empty | ||||||||||||||||||||||||||||||
object or null The billing address. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object or null The delivery address. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
couponIds | Array of strings The list of coupons applied to the order. | ||||||||||||||||||||||||||||||
shippingRateId | string <= 50 characters The resource ID. Defaults to UUID v4. |
Purchase preview was retrieved.
currency | string 3 characters ISO 4217 alphabetic currency code. | ||||||||||||||
Array of objects Purchase items array. | |||||||||||||||
Array
| |||||||||||||||
Array of objects (ShippingOption) Available shipping rates. | |||||||||||||||
Array
| |||||||||||||||
Array of objects Taxes applied to this purchase. | |||||||||||||||
Array of objects Discounts applied to this purchase. | |||||||||||||||
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. |
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "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"
}
{- "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
}
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
.
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. | ||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object The billing address. | |||||||||||||||||||||||||||||||||||
|