Create a transaction of type credit
.
Transaction resource.
Transaction was created.
Location | string <uri> The location of the related resource. Example: "https://api.rebilly.com/example" |
id | string <= 50 characters The transaction ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
websiteId | string <= 50 characters The website ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customerId | string <= 50 characters The customer 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 parent's transaction ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 Payment Gateway name, available only after the gateway is selected for the transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customFields | object (ResourceCustomFields) Default: {} Custom Fields list as a map | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
processedTime | string <date-time> Transaction processed time. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdTime | string <date-time> Transaction created time. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedTime | string <date-time> Read-only timestamp updates when the resource is updated. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gatewayAccountId | string <= 50 characters The transaction's Gateway Account ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gatewayTransactionId | string <= 50 characters The gateway's transaction ID. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The related gateway information. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
acquirerName | string Acquirer name, available only when transaction use gateway, else null. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
method | string Deprecated Payment Method. Use | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
velocity | integer The number of transactions by the same customer in the past 24 hours. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
revision | integer The number of times the transaction data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null Transaction reference data. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bin | string <bin> Payment Card BIN. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Vaulted instrument (object) or Alternative Instrument (object) or Cash (object) or Check (object) (PaymentInstrumentValueObject) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Any of: Vaulted payment instrument.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hasDcc | boolean True if transaction has Dynamic Currency Conversion applied. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Dynamic Currency Conversion detailed information. Null if hasDcc is false. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hasBumpOffer | boolean True if transaction has a Bump offer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Bump offer information. Null if hasBumpOffer is false. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
riskScore | integer The transaction's risk score. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Risk metadata) Risk metadata. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notificationUrl | string <uri> (TransactionNotificationUrl) The URL where a server-to-server POST notification will be sent. It will be sent when the
transaction's result is finalized after a timeout or an offsite interaction. Do not trust the
notification; follow with a GET request to confirm the result of the transaction. Please
respond with a 2xx HTTP status code, or we will reattempt the request again.
The 2 placeholders are available to use in this URI: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isDisputed | boolean True if transaction is disputed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disputeTime | string or null <date-time> Time the dispute was created, else null. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
disputeStatus | string or null The dispute's status, else null. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isReconciled | boolean True if the transaction has been verified with gateway batch data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isProcessedOutside | boolean True if the transaction was processed outside of Rebilly. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isMerchantInitiated | boolean True if the transaction was initiated by the merchant. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hadDiscrepancy | boolean True if the transaction has been updated due to a discrepancy with its. source of truth. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orderId | string Deprecated The transaction's order ID. This ID must be unique within a 24 hour period. This field was renamed to the | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
arn | string The acquirer reference number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reportAmount | number <double> Transaction amount converted to organization selected report currency. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reportCurrency | string = 3 characters ISO 4217 alphabetic currency code. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
settlementTime | string or null <date-time> The time that the transaction was settled by the banking instuition. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discrepancyTime | string or null <date-time> The time of the most recent discrepancy on the transaction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object or null (LimitAmount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of Self (object) or WebsiteLink (object) or CustomerLink (object) or GatewayAccountLink (object) or PaymentCardLink (object) or ParentTransactionLink (object) or LeadSourceLink (object) or ApprovalUrlLink (object) or RefundUrlLink (object) or TransactionUpdateUrlLink (object) or DisputeLink (object) or InvoicesLink (object) or QueryUrlLink (object) or TransactionRedirectUrlLink (object) non-empty The links related to resource. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of ParentTransactionEmbed (object) or GatewayAccountEmbed (object) or CustomerEmbed (object) or LeadSourceEmbed (object) or WebsiteEmbed (object) or PaymentCardEmbed (object) or BankAccountEmbed (object) or InvoicesEmbed (object) or ChildTransactionsEmbed (object) non-empty Any embedded objects available that are requested by the | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized access, invalid credentials were used.
Access forbidden.
Conflict.
Invalid data was sent.
{- "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "customerId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "currency": "USD",
- "amount": 97.97,
- "invoiceIds": [
- "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
], - "paymentInstruction": {
- "token": "string"
}, - "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"
}, - "requestId": "44433322-2c4y-483z-a0a9-158621f77a21",
- "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "description": "string",
- "customFields": {
- "foo": "bar"
}, - "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"
}
}, - "isProcessedOutside": false,
- "isMerchantInitiated": false,
- "processedTime": "2019-08-24T14:15:22Z"
}
{- "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,
- "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",
- "gatewayAccountId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gatewayTransactionId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "gateway": {
- "response": {
- "code": "string",
- "message": "string",
- "type": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "avsResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}, - "cvvResponse": {
- "code": "string",
- "message": "string",
- "originalCode": "string",
- "originalMessage": "string"
}
}, - "acquirerName": "Adyen",
- "method": "payment-card",
- "velocity": 0,
- "revision": 0,
- "referenceData": {
- "gatewayTransactionId": "GAT123"
}, - "bin": "string",
- "paymentInstrument": {
- "method": "payment-card",
- "paymentInstrumentId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21"
}, - "hasDcc": true,
- "dcc": {
- "base": {
- "amount": 10,
- "currency": "USD"
}, - "quote": {
- "amount": 10,
- "currency": "USD"
}, - "usdMarkup": 10,
- "outcome": "rejected"
}, - "hasBumpOffer": true,
- "bumpOffer": {
- "order": {
- "amount": 10,
- "currency": "USD"
}, - "version": "string",
- "language": "US",
- "outcome": "presented",
- "presentedOffers": [
- {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
], - "selectedOffer": {
- "offerId": "string",
- "offerType": "bonus",
- "bumpAmount": 10,
- "bumpAmountInUsd": 10,
- "customFields": {
- "foo": "bar"
}
}
}, - "riskScore": 0,
- "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"
}, - "isProxy": true,
- "isVpn": true,
- "isTor": true,
- "isHosting": true,
- "vpnServiceName": "string",
- "isp": "string",
- "country": "US",
- "region": "NY",
- "city": "New York",
- "latitude": 0,
- "longitude": 0,
- "postalCode": "string",
- "timeZone": "America/New_York",
- "accuracyRadius": 0,
- "distance": 0,
- "hasMismatchedBillingAddressCountry": true,
- "hasMismatchedBankCountry": true,
- "hasMismatchedTimeZone": true,
- "hasMismatchedHolderName": true,
- "hasFakeName": true,
- "isHighRiskCountry": true,
- "paymentInstrumentVelocity": 0,
- "deviceVelocity": 0,
- "ipVelocity": 0,
- "emailVelocity": 0,
- "billingAddressVelocity": 0,
- "score": 0
}, - "isDisputed": true,
- "disputeTime": "2019-08-24T14:15:22Z",
- "disputeStatus": "response-needed",
- "isReconciled": true,
- "isProcessedOutside": true,
- "isMerchantInitiated": true,
- "hadDiscrepancy": true,
- "orderId": "string",
- "arn": "74836950144358910018150",
- "reportAmount": 0,
- "reportCurrency": "USD",
- "settlementTime": "2019-08-24T14:15:22Z",
- "discrepancyTime": "2019-08-24T14:15:22Z",
- "limits": {
- "amount": 275.35,
- "currency": "USD",
- "resetTime": "2019-08-24T14:15:22Z"
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
], - "_embedded": [
- {
- "parentTransaction": null
}
]
}