The Rebilly API is built on HTTP and is RESTful. It has predictable resource URLs and returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. Use your favorite HTTP/REST library in your programming language when using this API, or use one of the Rebilly SDKs, which are available in PHP and JavaScript.
Every action in the Rebilly UI is supported by an API which is documented and available for use, so that you may automate any necessary workflows or processes. This API reference documentation contains the most commonly integrated resources.
This topic describes the different forms of authentication that are available in the Rebilly API, and how to use them.
Rebilly offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
To create or manage API keys, select one of the following:
For more information on API keys, see API keys.
Rebilly follows the error response format proposed in RFC 9457, which is also known as Problem Details for HTTP APIs. As with any API responses, your client must be prepared to gracefully handle additional members of the response.
Rebilly provides a JavaScript SDK and a PHP SDK to help interact with the Rebilly API. However, no SDK is required to use the API.
Rebilly also provides FramePay, a client-side iFrame-based solution, to help create payment tokens while minimizing PCI DSS compliance burdens and maximizing your customization ability. FramePay interacts with the payment tokens creation operation.
For installation and usage instructions, see SDKs. All JavaScript SDK code examples are included in the API reference documentation.
For installation and usage instructions, see SDKs. All SDK code examples are included in the API reference documentation. To use them, you must configure the $client as follows:
$client = new Rebilly\Client([ 'apiKey' => 'YourApiKeyHere', 'baseUrl' => 'https://api.rebilly.com', ]);
The full Rebilly API has over 500 operations. This is likely more than you may need to implement your use cases. If you would like to implement a particular use case, contact Rebilly for guidance and feedback on the best API operations to use for the task.
To integrate Rebilly, and learn about related resources and concepts, see Get started.
Rebilly enforces rate limits on the API to ensure that no single organization consumes too many resources. Rate limits are applied to the organization, and not to the API key. In sandbox environment, rate limits are enforced for non-GET endpoints and are set at 3000 requests per 10 minutes. You can find the exact number of consumed requests in the X-RateLimit-Limit and X-RateLimit-Remaining headers in the response. If the rate limit is exceeded, the API returns a 429 Too Many Requests response and a X-RateLimit-Retry-After header that includes a UTC timestamp of when the rate limit resets.
Use these operations to manage customers. A customer is an entity that purchases goods or services from you (a merchant), and is the payee in any transaction that is credited to you. Customers are associated with payment instruments, subscriptions, invoices, and other related resources.
In other systems, customers may be referred to as accounts, clients, members, patrons, or players. For information on the customer resource, see Resources.
Use these operations to manage payment instruments. Payment instrument is a term which describes any means of making a digital payment, such as: credit cards, debit cards, direct debits, payment service providers, and digital wallets.
For more information on payment instruments, see Payment instruments.
Use payment tokens to reduce the scope of PCI DSS compliance.
A payment token can be made using a different authentication scheme (public key authentication), which enables you to create a payment token directly from the browser. This bypasses the need to send sensitive cardholder info to your servers. We recommend using this with the FramePay library, which helps you integrate a form into this API resource and create payment tokens.
Retrieves available payment methods for a specific transaction or purchase.
The order in which the payment methods are displayed to the customer should be the same as the order in the response.
The list of payment methods is generated from available gateway accounts and the last matched adjust-ready-to-pay action on the ready-to-pay-requested event. If no rules match for the specific request, all methods supported by the gateway accounts are sent.
To invert this behavior, place an all matching rule at the end of the ready-to-pay-requested event in the rules engine, and include an empty paymentMethods property for the adjust-ready-to-pay action.
For more information, see Update event rules and Gateway accounts.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
Risk metadata used for 3D Secure and risk scoring.
Customer's device fingerprint. A device fingerprint is a unique token that is used to identify the customer. The device fingerprint is generated based on device attributes, such as: hardware, software, IP address, language, browser, and more.
curl -i -X POST \ https://www.rebilly.com/_mock/docs/dev-docs/api/ready-to-pay \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "currency": "USD", "amount": 0.1, "billingAddress": { "firstName": "Benjamin", "lastName": "Franklin", "organization": "Rebilly", "address": "36 Craven St", "address2": "string", "city": "Austin", "region": "Texas", "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" }, "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, "isAdBlockEnabled": true }, "extraData": { "kountFraudSessionId": "abcdefg12345abababab123456789012", "payPalMerchantSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowa", "threatMetrixSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa" } }, "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF" }'
Payment methods retrieved.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
Payment method.
Specific feature of this method. For example, a digital wallet. If the method does not have any features, this value is null.
Specific feature of this method. For example, a digital wallet. If the method does not have any features, this value is null.
List of supported brands.
For the method to be applicable, one or more of the following filters must match. If no filters are sent, no restrictions are applied. For more information, see Using filters.
[ { "method": "payment-card", "feature": { … }, "brands": [ … ], "filters": [ … ] } ]
Creates a transaction of type sale, authorize or setup.
Use this operation for the following transactions.
In this transaction, you send a request and inspect the result of the response for approved or declined.
In this transaction, user approval is required to complete the transaction. User approval generally requires the user to interact with a third party, and is common in many transactions for alternative methods. For example, PayPal requires user permission to complete a payment or to accept a billing agreement. Payment cards may also require user approval for 3D secure authentication.
If approval is required, you receive a response with a result value of unknown and a status value of waiting-approval. The _links property of the response has a link for the approvalUrl. Open the approvalUrl in an iframe or in a pop. A pop is a better workflow for mobile devices.
Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.
For more information, see Expand to include embedded objects.
Transaction resource.
Specifies whether to create or update (upsert) a customer. If this value is true, the operation creates or updates (upserts) a customer. If this value is false, the customerId already exists, and the related customer is not updated.
Type of transaction.
This field supports a limited subset of transaction types. To refund or void, see Refund a transaction.
To capture, use the sale type. If any existing authorize transactions are eligible, they are captured and the sale converts to a capture type.
The setup type sets up the payment instrument by following the setupInstruction in the selected gateway account. If the instruction is to do-nothing, a transaction with result approved of type setup returns.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
Array of invoice IDs.
Payment instruction for the purchase. If this value is not supplied, the customer's default payment instrument is used.
Billing address. If this value is not supplied, the billing address associated with the payment instrument is used. If no billing address is associated with the payment instrument, the customer's billing address is used.
Billing address. If this value is not supplied, the billing address associated with the payment instrument is used. If no billing address is associated with the payment instrument, the customer's billing address is used.
Use this field to prevent duplicate transaction requests that may occur within a short period of time. If a duplicate request is sent with the same requestId, it is ignored to prevent double-billing. This value must be unique within a 24-hour period.
Important: This field is recommended.
ID of the gateway account. Rebilly selects the payment gateway account for the transaction based on transaction properties and the rules configuration of the gateway-account-requested event. To prevent Rebilly from making the gateway account selection, supply a gateway account ID in this field. Only use this field if you intend to override the settings.
URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
Do not interpret this notification as a confirmation, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.
The following placeholders are available to use in this URI: {id} and {result}. These placeholders are replaced the with the transaction ID and result accordingly.
URL to redirect the end-user when an offsite transaction is completed. Defaults to the configured URL of the website. You may use {id} or {result} as placeholders in the URL, these are replaced the with the transaction ID and result accordingly.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Specifies when the transaction is initiated by the merchant.
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/transactions?expand=string' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "upsertCustomer": false, "type": "sale", "limits": { "amount": 275.35, "currency": "USD", "resetTime": "2019-08-24T14:15:22Z" }, "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "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": "Austin", "region": "Texas", "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": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "description": "string", "notificationUrl": "http://example.com", "redirectUrl": "http://example.com", "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, "isAdBlockEnabled": true }, "extraData": { "kountFraudSessionId": "abcdefg12345abababab123456789012", "payPalMerchantSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowa", "threatMetrixSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa" } }, "isProcessedOutside": false, "isMerchantInitiated": false, "processedTime": "2019-08-24T14:15:22Z" }'
Transaction created.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the customer resource.
Type of transaction.
Status of the transaction.
Result of the transaction.
Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount.
Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount.
ID of the transaction.
IDs of child transactions.
Related invoice IDs.
Subscription IDs of invoices that are related to the transaction.
Plan IDs of orders that are related to the transaction.
Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.
Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.
Authentication object. For more information, see 3D Secure (3DS).
URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL.
Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters.
Request ID of the transaction. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.
Payment gateway name.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Read-only timestamp in ISO 8601 date-time format.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the gateway account that processed the transaction.
ID of the gateway transaction.
Acquirer name.
Number of times the transaction data has been modified.
This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
Transaction reference data.
Vaulted payment instrument.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Detailed Dynamic currency conversion (DCC). If DCC is not applied to the transaction, this value is null.
Specifies if the transaction has a bump offer. A bump offer is a discount, purchase bonus, deal, that is offered to the customer during checkout.
Bump offer information. If the transaction does not have an associated bump offer, this value is null.
URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
Do not interpret this notification as a confirmation, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.
The following placeholders are available to use in this URI: {id} and {result}. These placeholders are replaced the with the transaction ID and result accordingly.
Date and time when the dispute is created. If the transaction is not disputed, this value is null.
Status of the dispute.
Specifies if the transaction is updated due to a discrepancy with its source of truth.
Transaction amount converted to the report currency of the organization.
Date and time when the transaction is settled by the banking institution.
Date and time of the most recent discrepancy on the transaction.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request.
ID of the payout request if applicable. The created transaction is based on the properties of this payout request.
Payment method.
{ "id": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "type": "3ds-authentication", "status": "completed", "result": "abandoned", "amount": 0.1, "currency": "USD", "purchaseAmount": 0.1, "purchaseCurrency": "USD", "requestAmount": 0.1, "requestCurrency": "USD", "parentTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "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": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ … ], "emails": [ … ], "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", "gatewayAccountId": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "gatewayTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "gateway": { "response": { … }, "avsResponse": { … }, "cvvResponse": { … } }, "acquirerName": "Adyen", "method": "payment-card", "velocity": 0, "revision": 0, "referenceData": { "gatewayTransactionId": "GAT123" }, "bin": "string", "paymentInstrument": { "method": "payment-card", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N" }, "hasDcc": true, "dcc": { "base": { … }, "quote": { … }, "usdMarkup": 10, "outcome": "rejected" }, "hasBumpOffer": true, "bumpOffer": { "order": { … }, "version": "string", "language": "US", "outcome": "presented", "presentedOffers": [ … ], "selectedOffer": { … } }, "riskScore": 0, "riskMetadata": { "ipAddress": "93.92.91.90", "fingerprint": "pIUt3xbgX3l9g3YDiLbx", "httpHeaders": { … }, "browserData": { … }, "extraData": { … }, "isProxy": true, "isVpn": true, "isTor": true, "isHosting": true, "hostingName": "string", "isp": "string", "country": "US", "region": "NY", "city": "New York", "latitude": 0.1, "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, "declinedPaymentInstrumentVelocity": 0, "deviceVelocity": 0, "ipVelocity": 0, "emailVelocity": 0, "billingAddressVelocity": 0, "paymentInstrumentApprovedTransactionCount": 0, "score": 0 }, "notificationUrl": "http://example.com", "isDisputed": true, "disputeTime": "2019-08-24T14:15:22Z", "disputeStatus": null, "isReconciled": true, "isProcessedOutside": true, "isMerchantInitiated": true, "hadDiscrepancy": true, "orderId": "string", "arn": "74836950144358910018150", "reportAmount": 0.1, "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" }, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "depositRequestId": "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7", "payoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "_links": [ { … } ], "_embedded": { "parentTransaction": {}, "childTransactions": [], "gatewayAccount": {}, "customer": {}, "leadSource": {}, "website": {}, "invoices": [], "organization": {}, "dispute": {}, "paymentCard": {}, "bankAccount": {} } }
Specifies the starting point within the collection of items to be returned.
Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.
For more information, see Using filter with collections.
Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.
Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.
For more information, see Expand to include embedded objects.
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/transactions?expand=string&filter=string&limit=1000&offset=1000&q=string&sort=string' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
List of transactions retrieved.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the customer resource.
Type of transaction.
Status of the transaction.
Result of the transaction.
Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount.
Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount.
ID of the transaction.
IDs of child transactions.
Related invoice IDs.
Subscription IDs of invoices that are related to the transaction.
Plan IDs of orders that are related to the transaction.
Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.
Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.
Authentication object. For more information, see 3D Secure (3DS).
URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL.
Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters.
Request ID of the transaction. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.
Payment gateway name.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Read-only timestamp in ISO 8601 date-time format.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the gateway account that processed the transaction.
ID of the gateway transaction.
Acquirer name.
Number of times the transaction data has been modified.
This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
Transaction reference data.
Vaulted payment instrument.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Detailed Dynamic currency conversion (DCC). If DCC is not applied to the transaction, this value is null.
Specifies if the transaction has a bump offer. A bump offer is a discount, purchase bonus, deal, that is offered to the customer during checkout.
Bump offer information. If the transaction does not have an associated bump offer, this value is null.
URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
Do not interpret this notification as a confirmation, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.
The following placeholders are available to use in this URI: {id} and {result}. These placeholders are replaced the with the transaction ID and result accordingly.
Date and time when the dispute is created. If the transaction is not disputed, this value is null.
Status of the dispute.
Specifies if the transaction is updated due to a discrepancy with its source of truth.
Transaction amount converted to the report currency of the organization.
Date and time when the transaction is settled by the banking institution.
Date and time of the most recent discrepancy on the transaction.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request.
ID of the payout request if applicable. The created transaction is based on the properties of this payout request.
Payment method.
Order ID of the transaction. This ID must be unique within a 24 hour period.
Note: Use the
requestIdfield instead.
[ { "id": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "type": "3ds-authentication", "status": "completed", "result": "abandoned", "amount": 0.1, "currency": "USD", "purchaseAmount": 0.1, "purchaseCurrency": "USD", "requestAmount": 0.1, "requestCurrency": "USD", "parentTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "childTransactions": [ … ], "invoiceIds": [ … ], "subscriptionIds": [ … ], "planIds": [ … ], "isRebill": true, "rebillNumber": 0, "billingAddress": { … }, "has3ds": true, "3ds": { … }, "redirectUrl": "http://example.com", "retryNumber": 0, "isRetry": true, "billingDescriptor": "string", "description": "string", "requestId": "string", "hasAmountAdjustment": true, "gatewayName": "A1Gateway", "customFields": { … }, "processedTime": "2019-08-24T14:15:22Z", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "gatewayAccountId": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "gatewayTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "gateway": { … }, "acquirerName": "Adyen", "method": "payment-card", "velocity": 0, "revision": 0, "referenceData": { … }, "bin": "string", "paymentInstrument": { … }, "hasDcc": true, "dcc": { … }, "hasBumpOffer": true, "bumpOffer": { … }, "riskScore": 0, "riskMetadata": { … }, "notificationUrl": "http://example.com", "isDisputed": true, "disputeTime": "2019-08-24T14:15:22Z", "disputeStatus": null, "isReconciled": true, "isProcessedOutside": true, "isMerchantInitiated": true, "hadDiscrepancy": true, "orderId": "string", "arn": "74836950144358910018150", "reportAmount": 0.1, "reportCurrency": "USD", "settlementTime": "2019-08-24T14:15:22Z", "discrepancyTime": "2019-08-24T14:15:22Z", "limits": { … }, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "depositRequestId": "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7", "payoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "_links": [ … ], "_embedded": { … } } ]
Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.
For more information, see Expand to include embedded objects.
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/transactions/{id}?expand=string' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Transaction retrieved.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the customer resource.
Type of transaction.
Status of the transaction.
Result of the transaction.
Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount.
Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount.
ID of the transaction.
IDs of child transactions.
Related invoice IDs.
Subscription IDs of invoices that are related to the transaction.
Plan IDs of orders that are related to the transaction.
Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.
Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.
Authentication object. For more information, see 3D Secure (3DS).
URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL.
Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters.
Request ID of the transaction. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.
Payment gateway name.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Read-only timestamp in ISO 8601 date-time format.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the gateway account that processed the transaction.
ID of the gateway transaction.
Acquirer name.
Number of times the transaction data has been modified.
This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
Transaction reference data.
Vaulted payment instrument.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Detailed Dynamic currency conversion (DCC). If DCC is not applied to the transaction, this value is null.
Specifies if the transaction has a bump offer. A bump offer is a discount, purchase bonus, deal, that is offered to the customer during checkout.
Bump offer information. If the transaction does not have an associated bump offer, this value is null.
URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
Do not interpret this notification as a confirmation, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.
The following placeholders are available to use in this URI: {id} and {result}. These placeholders are replaced the with the transaction ID and result accordingly.
Date and time when the dispute is created. If the transaction is not disputed, this value is null.
Status of the dispute.
Specifies if the transaction is updated due to a discrepancy with its source of truth.
Transaction amount converted to the report currency of the organization.
Date and time when the transaction is settled by the banking institution.
Date and time of the most recent discrepancy on the transaction.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request.
ID of the payout request if applicable. The created transaction is based on the properties of this payout request.
Payment method.
{ "id": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "type": "3ds-authentication", "status": "completed", "result": "abandoned", "amount": 0.1, "currency": "USD", "purchaseAmount": 0.1, "purchaseCurrency": "USD", "requestAmount": 0.1, "requestCurrency": "USD", "parentTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "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": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ … ], "emails": [ … ], "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", "gatewayAccountId": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "gatewayTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "gateway": { "response": { … }, "avsResponse": { … }, "cvvResponse": { … } }, "acquirerName": "Adyen", "method": "payment-card", "velocity": 0, "revision": 0, "referenceData": { "gatewayTransactionId": "GAT123" }, "bin": "string", "paymentInstrument": { "method": "payment-card", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N" }, "hasDcc": true, "dcc": { "base": { … }, "quote": { … }, "usdMarkup": 10, "outcome": "rejected" }, "hasBumpOffer": true, "bumpOffer": { "order": { … }, "version": "string", "language": "US", "outcome": "presented", "presentedOffers": [ … ], "selectedOffer": { … } }, "riskScore": 0, "riskMetadata": { "ipAddress": "93.92.91.90", "fingerprint": "pIUt3xbgX3l9g3YDiLbx", "httpHeaders": { … }, "browserData": { … }, "extraData": { … }, "isProxy": true, "isVpn": true, "isTor": true, "isHosting": true, "hostingName": "string", "isp": "string", "country": "US", "region": "NY", "city": "New York", "latitude": 0.1, "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, "declinedPaymentInstrumentVelocity": 0, "deviceVelocity": 0, "ipVelocity": 0, "emailVelocity": 0, "billingAddressVelocity": 0, "paymentInstrumentApprovedTransactionCount": 0, "score": 0 }, "notificationUrl": "http://example.com", "isDisputed": true, "disputeTime": "2019-08-24T14:15:22Z", "disputeStatus": null, "isReconciled": true, "isProcessedOutside": true, "isMerchantInitiated": true, "hadDiscrepancy": true, "orderId": "string", "arn": "74836950144358910018150", "reportAmount": 0.1, "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" }, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "depositRequestId": "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7", "payoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "_links": [ { … } ], "_embedded": { "parentTransaction": {}, "childTransactions": [], "gatewayAccount": {}, "customer": {}, "leadSource": {}, "website": {}, "invoices": [], "organization": {}, "dispute": {}, "paymentCard": {}, "bankAccount": {} } }
Use the patch transaction request to modify custom fields.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
curl -i -X PATCH \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/transactions/{id}' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "customFields": { "foo": "bar" } }'
Transaction updated.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the customer resource.
Type of transaction.
Status of the transaction.
Result of the transaction.
Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount.
Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount.
ID of the transaction.
IDs of child transactions.
Related invoice IDs.
Subscription IDs of invoices that are related to the transaction.
Plan IDs of orders that are related to the transaction.
Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.
Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.
Authentication object. For more information, see 3D Secure (3DS).
URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL.
Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters.
Request ID of the transaction. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.
Payment gateway name.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Read-only timestamp in ISO 8601 date-time format.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the gateway account that processed the transaction.
ID of the gateway transaction.
Acquirer name.
Number of times the transaction data has been modified.
This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
Transaction reference data.
Vaulted payment instrument.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Detailed Dynamic currency conversion (DCC). If DCC is not applied to the transaction, this value is null.
Specifies if the transaction has a bump offer. A bump offer is a discount, purchase bonus, deal, that is offered to the customer during checkout.
Bump offer information. If the transaction does not have an associated bump offer, this value is null.
URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
Do not interpret this notification as a confirmation, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.
The following placeholders are available to use in this URI: {id} and {result}. These placeholders are replaced the with the transaction ID and result accordingly.
Date and time when the dispute is created. If the transaction is not disputed, this value is null.
Status of the dispute.
Specifies if the transaction is updated due to a discrepancy with its source of truth.
Transaction amount converted to the report currency of the organization.
Date and time when the transaction is settled by the banking institution.
Date and time of the most recent discrepancy on the transaction.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request.
ID of the payout request if applicable. The created transaction is based on the properties of this payout request.
Payment method.
{ "id": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "type": "3ds-authentication", "status": "completed", "result": "abandoned", "amount": 0.1, "currency": "USD", "purchaseAmount": 0.1, "purchaseCurrency": "USD", "requestAmount": 0.1, "requestCurrency": "USD", "parentTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "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": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ … ], "emails": [ … ], "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", "gatewayAccountId": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "gatewayTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "gateway": { "response": { … }, "avsResponse": { … }, "cvvResponse": { … } }, "acquirerName": "Adyen", "method": "payment-card", "velocity": 0, "revision": 0, "referenceData": { "gatewayTransactionId": "GAT123" }, "bin": "string", "paymentInstrument": { "method": "payment-card", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N" }, "hasDcc": true, "dcc": { "base": { … }, "quote": { … }, "usdMarkup": 10, "outcome": "rejected" }, "hasBumpOffer": true, "bumpOffer": { "order": { … }, "version": "string", "language": "US", "outcome": "presented", "presentedOffers": [ … ], "selectedOffer": { … } }, "riskScore": 0, "riskMetadata": { "ipAddress": "93.92.91.90", "fingerprint": "pIUt3xbgX3l9g3YDiLbx", "httpHeaders": { … }, "browserData": { … }, "extraData": { … }, "isProxy": true, "isVpn": true, "isTor": true, "isHosting": true, "hostingName": "string", "isp": "string", "country": "US", "region": "NY", "city": "New York", "latitude": 0.1, "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, "declinedPaymentInstrumentVelocity": 0, "deviceVelocity": 0, "ipVelocity": 0, "emailVelocity": 0, "billingAddressVelocity": 0, "paymentInstrumentApprovedTransactionCount": 0, "score": 0 }, "notificationUrl": "http://example.com", "isDisputed": true, "disputeTime": "2019-08-24T14:15:22Z", "disputeStatus": null, "isReconciled": true, "isProcessedOutside": true, "isMerchantInitiated": true, "hadDiscrepancy": true, "orderId": "string", "arn": "74836950144358910018150", "reportAmount": 0.1, "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" }, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "depositRequestId": "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7", "payoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "_links": [ { … } ], "_embedded": { "parentTransaction": {}, "childTransactions": [], "gatewayAccount": {}, "customer": {}, "leadSource": {}, "website": {}, "invoices": [], "organization": {}, "dispute": {}, "paymentCard": {}, "bankAccount": {} } }
Transaction resource.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
Array of invoice IDs.
Payment instruction for the purchase. If this value is not supplied, the customer's default payment instrument is used.
Billing address. If this value is not supplied, the billing address associated with the payment instrument is used. If no billing address is associated with the payment instrument, the customer's billing address is used.
Billing address. If this value is not supplied, the billing address associated with the payment instrument is used. If no billing address is associated with the payment instrument, the customer's billing address is used.
Use this field to prevent duplicate transaction requests that may occur within a short period of time. If a duplicate request is sent with the same requestId, it is ignored to prevent double-billing. This value must be unique within a 24-hour period.
Important: This field is recommended.
ID of the gateway account. Rebilly selects the payment gateway account for the transaction based on transaction properties and the rules configuration of the gateway-account-requested event. To prevent Rebilly from making the gateway account selection, supply a gateway account ID in this field. Only use this field if you intend to override the settings.
URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
Do not interpret this notification as a confirmation, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.
The following placeholders are available to use in this URI: {id} and {result}. These placeholders are replaced the with the transaction ID and result accordingly.
URL to redirect the end-user when an offsite transaction is completed. Defaults to the configured URL of the website. You may use {id} or {result} as placeholders in the URL, these are replaced the with the transaction ID and result accordingly.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Specifies when the transaction is initiated by the merchant.
Time the transaction is processed. This field is only specified if the transaction is processed outside Rebilly.
curl -i -X POST \ https://www.rebilly.com/_mock/docs/dev-docs/api/payouts \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "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": "Austin", "region": "Texas", "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": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "description": "string", "notificationUrl": "http://example.com", "redirectUrl": "http://example.com", "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, "isAdBlockEnabled": true }, "extraData": { "kountFraudSessionId": "abcdefg12345abababab123456789012", "payPalMerchantSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowa", "threatMetrixSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa" } }, "isProcessedOutside": false, "isMerchantInitiated": false, "processedTime": "2019-08-24T14:15:22Z", "payoutRequestId": "string" }'
Transaction created.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the customer resource.
Type of transaction.
Status of the transaction.
Result of the transaction.
Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount.
Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount.
ID of the transaction.
IDs of child transactions.
Related invoice IDs.
Subscription IDs of invoices that are related to the transaction.
Plan IDs of orders that are related to the transaction.
Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.
Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.
Authentication object. For more information, see 3D Secure (3DS).
URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL.
Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters.
Request ID of the transaction. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.
Payment gateway name.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Read-only timestamp in ISO 8601 date-time format.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the gateway account that processed the transaction.
ID of the gateway transaction.
Acquirer name.
Number of times the transaction data has been modified.
This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
Transaction reference data.
Vaulted payment instrument.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Detailed Dynamic currency conversion (DCC). If DCC is not applied to the transaction, this value is null.
Specifies if the transaction has a bump offer. A bump offer is a discount, purchase bonus, deal, that is offered to the customer during checkout.
Bump offer information. If the transaction does not have an associated bump offer, this value is null.
URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
Do not interpret this notification as a confirmation, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.
The following placeholders are available to use in this URI: {id} and {result}. These placeholders are replaced the with the transaction ID and result accordingly.
Date and time when the dispute is created. If the transaction is not disputed, this value is null.
Status of the dispute.
Specifies if the transaction is updated due to a discrepancy with its source of truth.
Transaction amount converted to the report currency of the organization.
Date and time when the transaction is settled by the banking institution.
Date and time of the most recent discrepancy on the transaction.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request.
ID of the payout request if applicable. The created transaction is based on the properties of this payout request.
Payment method.
{ "id": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "type": "3ds-authentication", "status": "completed", "result": "abandoned", "amount": 0.1, "currency": "USD", "purchaseAmount": 0.1, "purchaseCurrency": "USD", "requestAmount": 0.1, "requestCurrency": "USD", "parentTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "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": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ … ], "emails": [ … ], "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", "gatewayAccountId": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "gatewayTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "gateway": { "response": { … }, "avsResponse": { … }, "cvvResponse": { … } }, "acquirerName": "Adyen", "method": "payment-card", "velocity": 0, "revision": 0, "referenceData": { "gatewayTransactionId": "GAT123" }, "bin": "string", "paymentInstrument": { "method": "payment-card", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N" }, "hasDcc": true, "dcc": { "base": { … }, "quote": { … }, "usdMarkup": 10, "outcome": "rejected" }, "hasBumpOffer": true, "bumpOffer": { "order": { … }, "version": "string", "language": "US", "outcome": "presented", "presentedOffers": [ … ], "selectedOffer": { … } }, "riskScore": 0, "riskMetadata": { "ipAddress": "93.92.91.90", "fingerprint": "pIUt3xbgX3l9g3YDiLbx", "httpHeaders": { … }, "browserData": { … }, "extraData": { … }, "isProxy": true, "isVpn": true, "isTor": true, "isHosting": true, "hostingName": "string", "isp": "string", "country": "US", "region": "NY", "city": "New York", "latitude": 0.1, "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, "declinedPaymentInstrumentVelocity": 0, "deviceVelocity": 0, "ipVelocity": 0, "emailVelocity": 0, "billingAddressVelocity": 0, "paymentInstrumentApprovedTransactionCount": 0, "score": 0 }, "notificationUrl": "http://example.com", "isDisputed": true, "disputeTime": "2019-08-24T14:15:22Z", "disputeStatus": null, "isReconciled": true, "isProcessedOutside": true, "isMerchantInitiated": true, "hadDiscrepancy": true, "orderId": "string", "arn": "74836950144358910018150", "reportAmount": 0.1, "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" }, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "depositRequestId": "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7", "payoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "_links": [ { … } ], "_embedded": { "parentTransaction": {}, "childTransactions": [], "gatewayAccount": {}, "customer": {}, "leadSource": {}, "website": {}, "invoices": [], "organization": {}, "dispute": {}, "paymentCard": {}, "bankAccount": {} } }
Queries a transaction with a specified ID.
The query interacts with the related gateway account to obtain the result, amount, and currency. If after analysis, the transaction must be updated, see Update a transaction status.
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/transactions/{id}/query' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Transaction queried.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
Result of the transaction.
Status of the transaction.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "result": "abandoned", "status": "completed", "amount": 0.1, "currency": "USD" }
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/transactions/{id}/update' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "result": "abandoned", "amount": 0.1, "currency": "USD" }'
Transaction updated.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the customer resource.
Type of transaction.
Status of the transaction.
Result of the transaction.
Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount.
Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount.
ID of the transaction.
IDs of child transactions.
Related invoice IDs.
Subscription IDs of invoices that are related to the transaction.
Plan IDs of orders that are related to the transaction.
Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.
Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.
Authentication object. For more information, see 3D Secure (3DS).
URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL.
Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters.
Request ID of the transaction. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.
Payment gateway name.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Read-only timestamp in ISO 8601 date-time format.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the gateway account that processed the transaction.
ID of the gateway transaction.
Acquirer name.
Number of times the transaction data has been modified.
This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
Transaction reference data.
Vaulted payment instrument.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Detailed Dynamic currency conversion (DCC). If DCC is not applied to the transaction, this value is null.
Specifies if the transaction has a bump offer. A bump offer is a discount, purchase bonus, deal, that is offered to the customer during checkout.
Bump offer information. If the transaction does not have an associated bump offer, this value is null.
URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
Do not interpret this notification as a confirmation, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.
The following placeholders are available to use in this URI: {id} and {result}. These placeholders are replaced the with the transaction ID and result accordingly.
Date and time when the dispute is created. If the transaction is not disputed, this value is null.
Status of the dispute.
Specifies if the transaction is updated due to a discrepancy with its source of truth.
Transaction amount converted to the report currency of the organization.
Date and time when the transaction is settled by the banking institution.
Date and time of the most recent discrepancy on the transaction.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request.
ID of the payout request if applicable. The created transaction is based on the properties of this payout request.
Payment method.
{ "id": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "type": "3ds-authentication", "status": "completed", "result": "abandoned", "amount": 0.1, "currency": "USD", "purchaseAmount": 0.1, "purchaseCurrency": "USD", "requestAmount": 0.1, "requestCurrency": "USD", "parentTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "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": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ … ], "emails": [ … ], "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", "gatewayAccountId": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "gatewayTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "gateway": { "response": { … }, "avsResponse": { … }, "cvvResponse": { … } }, "acquirerName": "Adyen", "method": "payment-card", "velocity": 0, "revision": 0, "referenceData": { "gatewayTransactionId": "GAT123" }, "bin": "string", "paymentInstrument": { "method": "payment-card", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N" }, "hasDcc": true, "dcc": { "base": { … }, "quote": { … }, "usdMarkup": 10, "outcome": "rejected" }, "hasBumpOffer": true, "bumpOffer": { "order": { … }, "version": "string", "language": "US", "outcome": "presented", "presentedOffers": [ … ], "selectedOffer": { … } }, "riskScore": 0, "riskMetadata": { "ipAddress": "93.92.91.90", "fingerprint": "pIUt3xbgX3l9g3YDiLbx", "httpHeaders": { … }, "browserData": { … }, "extraData": { … }, "isProxy": true, "isVpn": true, "isTor": true, "isHosting": true, "hostingName": "string", "isp": "string", "country": "US", "region": "NY", "city": "New York", "latitude": 0.1, "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, "declinedPaymentInstrumentVelocity": 0, "deviceVelocity": 0, "ipVelocity": 0, "emailVelocity": 0, "billingAddressVelocity": 0, "paymentInstrumentApprovedTransactionCount": 0, "score": 0 }, "notificationUrl": "http://example.com", "isDisputed": true, "disputeTime": "2019-08-24T14:15:22Z", "disputeStatus": null, "isReconciled": true, "isProcessedOutside": true, "isMerchantInitiated": true, "hadDiscrepancy": true, "orderId": "string", "arn": "74836950144358910018150", "reportAmount": 0.1, "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" }, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "depositRequestId": "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7", "payoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "_links": [ { … } ], "_embedded": { "parentTransaction": {}, "childTransactions": [], "gatewayAccount": {}, "customer": {}, "leadSource": {}, "website": {}, "invoices": [], "organization": {}, "dispute": {}, "paymentCard": {}, "bankAccount": {} } }
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/transactions/{id}/refund' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "amount": 0.1, "description": "string", "isProcessedOutside": false }'
Transaction refunded.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the customer resource.
Type of transaction.
Status of the transaction.
Result of the transaction.
Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount.
Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount.
ID of the transaction.
IDs of child transactions.
Related invoice IDs.
Subscription IDs of invoices that are related to the transaction.
Plan IDs of orders that are related to the transaction.
Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.
Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.
Authentication object. For more information, see 3D Secure (3DS).
URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL.
Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters.
Request ID of the transaction. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.
Payment gateway name.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.
Read-only timestamp in ISO 8601 date-time format.
Date and time which is set automatically when the resource is created.
Date and time which updates automatically when the resource is updated.
ID of the gateway account that processed the transaction.
ID of the gateway transaction.
Acquirer name.
Number of times the transaction data has been modified.
This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.
Transaction reference data.
Vaulted payment instrument.
To use this payment instrument for automatic subscription renewals, and for transactions when no specific payment instrument is provided by the user, set this as the default payment instrument.
Detailed Dynamic currency conversion (DCC). If DCC is not applied to the transaction, this value is null.
Specifies if the transaction has a bump offer. A bump offer is a discount, purchase bonus, deal, that is offered to the customer during checkout.
Bump offer information. If the transaction does not have an associated bump offer, this value is null.
URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
Do not interpret this notification as a confirmation, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.
The following placeholders are available to use in this URI: {id} and {result}. These placeholders are replaced the with the transaction ID and result accordingly.
Date and time when the dispute is created. If the transaction is not disputed, this value is null.
Status of the dispute.
Specifies if the transaction is updated due to a discrepancy with its source of truth.
Transaction amount converted to the report currency of the organization.
Date and time when the transaction is settled by the banking institution.
Date and time of the most recent discrepancy on the transaction.
Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.
ID of the deposit request if applicable. The created transaction is based on the properties of this deposit request.
ID of the payout request if applicable. The created transaction is based on the properties of this payout request.
Payment method.
{ "id": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "type": "3ds-authentication", "status": "completed", "result": "abandoned", "amount": 0.1, "currency": "USD", "purchaseAmount": 0.1, "purchaseCurrency": "USD", "requestAmount": 0.1, "requestCurrency": "USD", "parentTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "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": "Austin", "region": "Texas", "country": "GB", "postalCode": "WC2N 5NF", "phoneNumbers": [ … ], "emails": [ … ], "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", "gatewayAccountId": "gw_acc_0YVCXMF26DDNKAERE5NW727S34", "gatewayTransactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "gateway": { "response": { … }, "avsResponse": { … }, "cvvResponse": { … } }, "acquirerName": "Adyen", "method": "payment-card", "velocity": 0, "revision": 0, "referenceData": { "gatewayTransactionId": "GAT123" }, "bin": "string", "paymentInstrument": { "method": "payment-card", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N" }, "hasDcc": true, "dcc": { "base": { … }, "quote": { … }, "usdMarkup": 10, "outcome": "rejected" }, "hasBumpOffer": true, "bumpOffer": { "order": { … }, "version": "string", "language": "US", "outcome": "presented", "presentedOffers": [ … ], "selectedOffer": { … } }, "riskScore": 0, "riskMetadata": { "ipAddress": "93.92.91.90", "fingerprint": "pIUt3xbgX3l9g3YDiLbx", "httpHeaders": { … }, "browserData": { … }, "extraData": { … }, "isProxy": true, "isVpn": true, "isTor": true, "isHosting": true, "hostingName": "string", "isp": "string", "country": "US", "region": "NY", "city": "New York", "latitude": 0.1, "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, "declinedPaymentInstrumentVelocity": 0, "deviceVelocity": 0, "ipVelocity": 0, "emailVelocity": 0, "billingAddressVelocity": 0, "paymentInstrumentApprovedTransactionCount": 0, "score": 0 }, "notificationUrl": "http://example.com", "isDisputed": true, "disputeTime": "2019-08-24T14:15:22Z", "disputeStatus": null, "isReconciled": true, "isProcessedOutside": true, "isMerchantInitiated": true, "hadDiscrepancy": true, "orderId": "string", "arn": "74836950144358910018150", "reportAmount": 0.1, "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" }, "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8", "depositRequestId": "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7", "payoutRequestId": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "_links": [ { … } ], "_embedded": { "parentTransaction": {}, "childTransactions": [], "gatewayAccount": {}, "customer": {}, "leadSource": {}, "website": {}, "invoices": [], "organization": {}, "dispute": {}, "paymentCard": {}, "bankAccount": {} } }
Specifies the starting point within the collection of items to be returned.
Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.
For more information, see Using filter with collections.
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/payout-requests?filter=string&limit=1000&offset=1000&sort=string' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
List of payout requests retrieved.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the requested payment instrument to offer for the payout.
Status of the request.
| Enum Value | Description |
|---|---|
| pending | Request is awaiting customer's selection of the payment instrument or fulfillment. |
| instrument-selected | Request has a selected payment instrument and is awaiting fulfillment. |
| partially-fulfilled | Request is partially paid out when |
| fulfilled | Request is fully paid out when |
| canceled | Request is canceled by merchant or customer. |
URL for the customer to select a preferred payment instrument.
List of credit transactions that are allocated to reduce the available amount of a payout request.
URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use {{id}} as a placeholder for the payout request ID.
Reason the payout request is canceled.
Read-only timestamp in ISO 8601 date-time format.
Date and time which updates automatically when the resource is updated.
[ { "id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "currency": "USD", "amount": 0.1, "availableAmount": 0.1, "description": "string", "status": "pending", "selectPaymentInstrumentUrl": "http://example.com", "allocations": [ … ], "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}", "cancellationReason": { … }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ] } ]
Creates a payout request. In the response, the selectPaymentInstrumentUrl field is used to redirect the customer to select a preferred payment instrument. After a payment instrument is selected, the customer is redirected to the selectedPaymentInstrumentRedirectUrl value.
Important: The selected payment gateway must be configured to support payout requests. For more information, see the readyToPayoutInstruction field.
Payout request resource.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the requested payment instrument to offer for the payout.
curl -i -X POST \ https://www.rebilly.com/_mock/docs/dev-docs/api/payout-requests \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "currency": "USD", "amount": 0.1, "description": "string", "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}" }'
Payout request created.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the requested payment instrument to offer for the payout.
Status of the request.
| Enum Value | Description |
|---|---|
| pending | Request is awaiting customer's selection of the payment instrument or fulfillment. |
| instrument-selected | Request has a selected payment instrument and is awaiting fulfillment. |
| partially-fulfilled | Request is partially paid out when |
| fulfilled | Request is fully paid out when |
| canceled | Request is canceled by merchant or customer. |
URL for the customer to select a preferred payment instrument.
List of credit transactions that are allocated to reduce the available amount of a payout request.
URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use {{id}} as a placeholder for the payout request ID.
Reason the payout request is canceled.
Read-only timestamp in ISO 8601 date-time format.
Date and time which updates automatically when the resource is updated.
{ "id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "currency": "USD", "amount": 0.1, "availableAmount": 0.1, "description": "string", "status": "pending", "selectPaymentInstrumentUrl": "http://example.com", "allocations": [ { … } ], "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}", "cancellationReason": { "canceledBy": "merchant", "description": "string" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/payout-requests/{id}' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Payout request retrieved.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the requested payment instrument to offer for the payout.
Status of the request.
| Enum Value | Description |
|---|---|
| pending | Request is awaiting customer's selection of the payment instrument or fulfillment. |
| instrument-selected | Request has a selected payment instrument and is awaiting fulfillment. |
| partially-fulfilled | Request is partially paid out when |
| fulfilled | Request is fully paid out when |
| canceled | Request is canceled by merchant or customer. |
URL for the customer to select a preferred payment instrument.
List of credit transactions that are allocated to reduce the available amount of a payout request.
URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use {{id}} as a placeholder for the payout request ID.
Reason the payout request is canceled.
Read-only timestamp in ISO 8601 date-time format.
Date and time which updates automatically when the resource is updated.
{ "id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "currency": "USD", "amount": 0.1, "availableAmount": 0.1, "description": "string", "status": "pending", "selectPaymentInstrumentUrl": "http://example.com", "allocations": [ { … } ], "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}", "cancellationReason": { "canceledBy": "merchant", "description": "string" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the requested payment instrument to offer for the payout.
curl -i -X PUT \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/payout-requests/{id}' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "currency": "USD", "amount": 0.1, "description": "string", "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}" }'
Payout request updated.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the requested payment instrument to offer for the payout.
Status of the request.
| Enum Value | Description |
|---|---|
| pending | Request is awaiting customer's selection of the payment instrument or fulfillment. |
| instrument-selected | Request has a selected payment instrument and is awaiting fulfillment. |
| partially-fulfilled | Request is partially paid out when |
| fulfilled | Request is fully paid out when |
| canceled | Request is canceled by merchant or customer. |
URL for the customer to select a preferred payment instrument.
List of credit transactions that are allocated to reduce the available amount of a payout request.
URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use {{id}} as a placeholder for the payout request ID.
Reason the payout request is canceled.
Read-only timestamp in ISO 8601 date-time format.
Date and time which updates automatically when the resource is updated.
{ "id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "currency": "USD", "amount": 0.1, "availableAmount": 0.1, "description": "string", "status": "pending", "selectPaymentInstrumentUrl": "http://example.com", "allocations": [ { … } ], "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}", "cancellationReason": { "canceledBy": "merchant", "description": "string" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
Payout request resource.
Specifies who initiated the cancellation.
curl -i -X POST \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/payout-requests/{id}/cancel' \ -H 'Content-Type: application/json' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE' \ -d '{ "canceledBy": "merchant", "description": "string" }'
Payout request canceled.
Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.
ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.
ID of the requested payment instrument to offer for the payout.
Status of the request.
| Enum Value | Description |
|---|---|
| pending | Request is awaiting customer's selection of the payment instrument or fulfillment. |
| instrument-selected | Request has a selected payment instrument and is awaiting fulfillment. |
| partially-fulfilled | Request is partially paid out when |
| fulfilled | Request is fully paid out when |
| canceled | Request is canceled by merchant or customer. |
URL for the customer to select a preferred payment instrument.
List of credit transactions that are allocated to reduce the available amount of a payout request.
URL where the customer is redirected when a payment instrument is selected. The default value is the website URL. Use {{id}} as a placeholder for the payout request ID.
Reason the payout request is canceled.
Read-only timestamp in ISO 8601 date-time format.
Date and time which updates automatically when the resource is updated.
{ "id": "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80", "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG", "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "currency": "USD", "amount": 0.1, "availableAmount": 0.1, "description": "string", "status": "pending", "selectPaymentInstrumentUrl": "http://example.com", "allocations": [ { … } ], "selectedPaymentInstrumentRedirectUrl": "https://example.com/payout-request-success?id={{id}}", "cancellationReason": { "canceledBy": "merchant", "description": "string" }, "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ { … } ] }
curl -i -X GET \ 'https://www.rebilly.com/_mock/docs/dev-docs/api/payout-requests/{id}/payment-instruments' \ -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Payout request associated payment instruments retrieved.
ID of the payment instrument to offer for the payout.
Name of the payment gateway and payment instrument to use for the payout. This field is empty if the requested payment instrument has not been used yet.
Total amount of sales minus credit for the specified gateway and instrument.
Total amount of allocated credit for the payout request for the specified gateway and instrument.
Date and time when the last payment is created for the gateway and the payment instrument.
Date and time when the last payout is created for the gateway and the payment instrument.
[ { "paymentInstrumentId": "inst_0YVB8KPKNXCBR9EDX7JHSED75N", "gatewayName": "A1Gateway", "exposureAmount": 0.1, "previousAllocatedAmount": 0.1, "lastPaymentTime": "2019-08-24T14:15:22Z", "lastPayoutTime": "2019-08-24T14:15:22Z" } ]
Customer redirect webhook request body resource.
Customer's browser HTTP headers.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "redirectUrl": "string", "ipAddress": "string", "httpHeaders": { "Content-Type": "application/json", "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" }, "eventType": "customer-redirected-offsite", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Customer redirect webhook request body resource.
Customer's browser HTTP headers.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "redirectUrl": "string", "ipAddress": "string", "httpHeaders": { "Content-Type": "application/json", "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" }, "eventType": "customer-redirected-offsite", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Payout request webhook request body resource.
Type of webhook event.
{ "payoutRequestId": "string", "eventType": "payout-request-created", "_embedded": { "payoutRequest": { … } }, "_links": [ { … } ] }
Payout request webhook request body resource.
Type of webhook event.
{ "payoutRequestId": "string", "eventType": "payout-request-created", "_embedded": { "payoutRequest": { … } }, "_links": [ { … } ] }
Payout request webhook request body resource.
Type of webhook event.
{ "payoutRequestId": "string", "eventType": "payout-request-created", "_embedded": { "payoutRequest": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Transaction webhook request body resource.
Type of webhook event.
{ "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0", "eventType": "gateway-account-requested", "_embedded": { "transaction": { … } }, "_links": [ { … } ] }
Use these operations to manage disputes. A dispute occurs when a customer contests a charge to their account. The dispute and related information is made available to the merchant by the bank or credit card company. The merchant then has the option to represent the charge and win the case. This process is called dispute resolution. If the merchant is unable to represent the charge, the card issuer typically reverses the sale and adds fees on top of the charge. This process is called a chargeback.
Use these operations to manage customer orders. An order is a customer's request to purchase items. It can contain subscription and one-time sale items. When an order contains one or more subscription items, it is a subscription order.
An order generates an invoice. A subscription order generates an invoice for each service period. For more information, see Orders.
Use these operations to manage the product usage of a subscription item for metered billing purposes.
Use metered billing when product quantity is unknown to the customer at the moment of creating a subscription. Metered billing is based on reported usage records. Every reported usage updates the quantity of an upcoming invoice item for a specified subscription and a plan. To create a metered billing plan, see Plans.
Use credit memos to provide a customer with store credit. A common use case for using a credit memo is to provide a customer with store credit, rather than a refund, if the customer pays more than they owe or returns a product. For information on the credit memo resource, see Resources.
Use pricing plans to describe how the customer must pay for products.
Rebilly provides the following plan types:
For information on the plans resource, see Plans.
For information on plan pricing, see Pricing formulas.
Use coupons to reward customers, generate sales, or to test new pricing strategies. Coupons enable you to apply different types of discounts to invoices, subscriptions, and pricing plans.
Redeemed coupons are attached to a customer's account. Depending on the coupon restrictions, the redeemed coupons are then applied from the customer's account to subsequent invoices or subscriptions. Redeemed coupons can only be applied to invoices of the same currency.
Once a coupon is redeemed it cannot be modified. You may deactivate a coupon or create a new coupon, but you cannot reuse the same coupon code. If you have a use case where you must reuse the same code, contact Rebilly.
Use quote operations to create and manage quotations. Quotations describe the cost of goods or services to potential customers before they commit to a purchase. A quote contains an initial invoice preview that can be accepted to become an order.
A quote can contain subscription and one-time sale items. When a quote contains one or more subscription items, it is a subscription order quote.
Use blocklists to prevent fraud and criminal activity.
Blocklists are lists of customer attribute values that are blocked from buying from you. For example, if a customer attempts to make a purchase from you with a credit card that is in a blocklist, the transaction is blocked and is not processed.
Before a new transaction is processed in Rebilly, blocklists are examined to check for attributes related to the entity. If a match is detected, the operation is aborted. A blocklist that expires after a period of time is called a greylist.
Use allowlists to exclude specific customer attribute data from risk score checks.
Allowlists are lists of data that are excluded from risk score checks. Allowlists prevent specific data from being added to a blocklist record when a risk score threshold reached.
Use Know Your Customer (KYC) documents to verify your customers identity. The KYC document operations generate a signed link to the Rebilly KYC document gatherer.
Document types:
identity-proof: Validates a customer's identity.address-proof: Validates a customer's address.purchase-proof: Validates a customer's purchase.funds-proof: Validates that a customer has funds.credit-file-proof: Verifies that there is an existing credit file with two sources that match the customer's name, DOB, and address.Rebilly parses and analyzes the documents and accepts or rejects them according to a configurable scoring algorithm. When all document types in a KYC request are accepted, the status is fulfilled, and the KYC request fulfilled webhook is sent.
Use Anti-Money Laundering (AML) operations to screen customers and help prevent your business from becoming directly or indirectly involved in criminal activity.
Use AML operations during customer creation, and some transaction processing, to help determine if a potential customer (lead), or customer, has political or economic sanctions against them.
AML operations search the following for screening purposes: Politically Exposed Persons (PEPs) lists, sanction lists, and adverse media lists.
Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. Depending on the resource on which the custom field is added, it may be available in the Rebilly UI.
Example: A custom field called preferredCommunicationChannel is added to the customer resource. It has two allowed values, which are 'email' and 'phone'.
{ "customFields": { "preferredCommunicationChannel": "email" } }
For detailed information on Rebilly resources, see Resources.
Use the file entity to store files and related metadata. Files can be sorted by size, MIME-type, user-defined tags, and description.
The following methods are available to upload files: multipart/form-data encoded form, RAW POST — by sending the file contents as the POST body, and fetching from URL — by providing the file URL using the 'url' parameter.
Use the attachments entity to link a file to one or multiple objects, such as: customer, dispute, transaction, order, plan, product, invoice, or timeline comment. Attachments enable you to quickly find and use files related to specific entities.