Rebilly REST API
Introduction The Rebilly API is built on HTTP. Our API is RESTful. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It…
Payments#openapi#payment#ecommerce
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Introduction
The Rebilly API is built on HTTP. Our API is RESTful. It has predictable
resource URLs. It returns HTTP response codes to indicate errors. It also
accepts and returns JSON in the HTTP body. You can use your favorite
HTTP/REST library for your programming language to use Rebilly's API, or
you can use one of our SDKs (currently available in PHP
and Javascript).
We have other APIs that are also available. Every action from our app
is supported by an API which is documented and available for use so that you
may automate any workflows necessary. This document contains the most commonly
integrated resources.
Authentication
When you sign up for an account, you are given your first secret API key.
You can generate additional API keys, and delete API keys (as you may
need to rotate your keys in the future). You authenticate to the
Rebilly API by providing your secret key in the request header.
Rebilly offers three forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.
- Secret API key: used for requests made
from the server side. Never share these keys. Keep them guarded and secure.
- Publishable API key: used for
requests from the client side. For now can only be used to create
a Payment Token and
a File token.
- JWT: short lifetime tokens that can be assigned a specific expiration time.
Never share your secret keys. Keep them guarded and secure.
<!-- ReDoc-Inject: <security-definitions> -->
Errors
Rebilly follow's the error response format proposed in RFC 7807 also known as Problem Details for HTTP APIs. As with our normal API responses, your client must be prepared to gracefully handle additional members of the response.
Forbidden
<RedocResponse pointer={"#/components/responses/Forbidden"} />
Conflict
<RedocResponse pointer={"#/components/responses/Conflict"} />
NotFound
<RedocResponse pointer={"#/components/responses/NotFound"} />
Unauthorized
<RedocResponse pointer={"#/components/responses/Unauthorized"} />
ValidationError
<RedocResponse pointer={"#/components/responses/ValidationError"} />
SDKs
Rebilly offers a Javascript SDK and a PHP SDK to help interact with
the API. However, no SDK is required to use the API.
Rebilly also offers FramePay,
a client-side iFrame-based solution to help
create payment tokens while minimizing PCI DSS compliance burdens
and maximizing the customizability. FramePay
is interacting with the payment tokens creation operation.
Javascript SDK
Installation and usage instructions can be found here.
SDK code examples are included in these docs.
PHP SDK
For all PHP SDK examples provided in these docs you will need to configure the $client.
You may do it like this:
$client = new Rebilly\Client([
'apiKey' => 'YourApiKeyHere',
'baseUrl' => 'https://api.rebilly.com',
]);Using filter with collections
Rebilly provides collections filtering. You can use ?filter param on collections to define which records should be shown in the response.
Here is filter format description:
- Fields and values in filter are separated with
::?filter=firstName:John.
- Sub-fields are separated with
.:?filter=billingAddress.country:US.
- Multiple filters are separated with
;:?filter=firstName:John;lastName:Doe. They will be joined withANDlogic. In this example:firstName:JohnANDlastName:Doe.
- You can use multiple values using
,as values separator:?filter=firstName:John,Bob. Multiple values specified for a field will be joined withORlogic. In this example:firstName:JohnORfirstName:Bob.
- To negate the filter use
!:?filter=firstName:!John. Note that you can negate multiple values like this:?filter=firstName:!John,!Bob. This filter rule will exclude all Johns and Bobs from the response.
- You can use range filters like this:
?filter=amount:1..10.
- You can use gte (greater than or equals) filter like this:
?filter=amount:1.., or lte (less than or equals) than filter like this:?filter=amount:..10. This also works for datetime-based fields.
- You can create some predefined values lists and use them in filter:
?filter=firstName:@yourListName. You can also exclude list values:?filter=firstName:!@yourListName.
- Datetime-based fields accept values formatted using RFC 3339 like this:
?filter=createdTime:2021-02-14T13:30:00Z.
Expand to include embedded…
Endpoints 184
3D Secure
- GETRetrieve a list of ThreeDSecure entries
/3dsecure?limit=0&offset=0 - POSTCreate a ThreeDSecure entry
/3dsecureCreate a ThreeDSecure entry. - GETRetrieve a ThreeDSecure entry
/3dsecure/:idRetrieve a ThreeDSecure entry with specified identifier string.
AML
- GETSearch PEP/Sanctions/Adverse Media lists
/aml?firstName=string&lastName=string&dob=string&country=stringSearch multiple PEP/Sanctions/Adverse Media lists with first and last name to find any blocklisted identities. Performs a fuzzy search including soundex. Not…
Bank Accounts
- GETRetrieve a list of bank accounts
/bank-accounts?limit=0&offset=0&q=string&sort=string&filter=string&expand=stringRetrieve a list of Bank Accounts. - POSTCreate a Bank Account
/bank-accountsCreate a Bank Account. - GETRetrieve a Bank Account
/bank-accounts/:idRetrieve a Bank Account with specified identifier string. - PUTCreate a Bank Account with predefined ID
/bank-accounts/:idCreate or update a BankAccount with predefined identifier string. - PATCHUpdate a bank account's values
/bank-accounts/:idUpdate bank account's values except for the account number and routing. number. - POSTDeactivate a Bank Account
/bank-accounts/:id/deactivationDeactivate a Bank Account.
Blocklists
- GETRetrieve a list of blocklists
/blocklists?limit=0&offset=0&sort=string&filter=string&q=stringRetrieve a list of blocklists. - POSTCreate a blocklist
/blocklistsCreate a blocklist. - GETRetrieve a blocklist
/blocklists/:idRetrieve a blocklist with specified identifier string. - PUTCreate a blocklist with predefined ID
/blocklists/:idCreate a blocklist with predefined identifier string. - DELETEDelete a blocklist
/blocklists/:idDelete a blocklist with predefined identifier string.
Coupons
- GETRetrieve a list of coupons
/coupons?limit=0&offset=0&filter=string&q=string&sort=stringRetrieve a list of coupons. - POSTCreate a coupon
/couponsCreate a coupon. - GETRetrieve a list of coupon redemptions
/coupons-redemptions?limit=0&offset=0&filter=string&q=string&sort=string - POSTRedeem a coupon
/coupons-redemptionsRedeem a coupon. - GETRetrieve a coupon redemption with specified identifier string
/coupons-redemptions/:id - POSTCancel a coupon redemption
/coupons-redemptions/:id/cancel - GETRetrieve a coupon
/coupons/:idRetrieve a coupon with specified coupon ID string. - PUTCreate or update a coupon with predefined coupon ID
/coupons/:idCreate or update a coupon with predefined coupon ID. - POSTSet a coupon's expiration time
/coupons/:id/expirationSet a coupon's expiry time with the specified coupon ID. The expiredTime of a coupon must be greater than its issuedTime. This cannot be performed on expired…
Customers
- POSTCreate Customer Timeline custom event type
/customer-timeline-custom-eventsCreate Customer Timeline custom event type. - GETRetrieve a list of customers
/customers?limit=0&offset=0&filter=string&q=string&expand=string&fields=string&sort=stringRetrieve a list of customers. - POSTCreate a customer (without an ID)
/customersCreate a customer without a predefined ID. The customer's primary address will be used as the default address for payment instruments, subscriptions and… - GETRetrieve a customer
/customers/:id?expand=string&fields=stringRetrieve a customer with specified identifier string. - PUTUpsert a customer with predefined ID
/customers/:idCreate or update (upsert) a customer with predefined identifier string. Read our guide to preventing duplicates to understand more. - DELETEMerge and delete a customer
/customers/:id?targetCustomerId=stringMerge one duplicate customer to another target customer and delete the. former. - GETRetrieve a customer's Lead Source
/customers/:id/lead-sourceRetrieve a Lead Source of given customer. - PUTCreate a Lead Source for a customer
/customers/:id/lead-sourceCreate a Lead Source for a customer. - DELETEDelete a Lead Source for a customer
/customers/:id/lead-sourceDelete a Lead Source that belongs to a certain customer.
Customers Timeline
- GETRetrieve a list of customer timeline custom event types
/customer-timeline-custom-events?limit=0&offset=0&filter=stringRetrieve a list of customer timeline custom event types. - GETRetrieve customer timeline custom event type with specified identifier string
/customer-timeline-custom-events/:idRetrieve customer timeline custom event type. - GETRetrieve a list of customer timeline messages for all customers
/customer-timeline-events?limit=0&offset=0&filter=stringRetrieve a list of customer timeline messages for all customers. - GETRetrieve a list of customer timeline messages
/customers/:id/timeline?limit=0&offset=0&filter=string&sort=string&q=stringRetrieve a list of customer timeline messages. - POSTCreate a customer Timeline comment or custom defined event
/customers/:id/timelineCreate a customer Timeline comment or custom defined event. - GETRetrieve a customer Timeline message
/customers/:id/timeline/:messageIdRetrieve a customer message with specified identifier string. - DELETEDelete a Customer Timeline message
/customers/:id/timeline/:messageIdDelete a Customer Timeline message with predefined identifier string.
KYC Documents
- GETRetrieve a list of KYC documents
/kyc-documents?limit=0&offset=0&filter=string&sort=stringRetrieve a list of KYC documents. - POSTCreate a KYC Document
/kyc-documentsCreate a KYC Document. - GETRetrieve a KYC Document
/kyc-documents/:idRetrieve a KYC document with specified identifier string. - PUTCreate or update a KYC document with predefined ID
/kyc-documents/:idCreate or update a KYC document with predefined identifier string. - POSTAccept a KYC document
/kyc-documents/:id/acceptanceMarks that status of the document as accepted. Updates the review time and reviewer information. Intended to be used for manual overrides. - POSTUpdate a KYC document's documentMatches
/kyc-documents/:id/matchesUpdates a KYC document's documentMatches. Intended to be used for manual overrides. - POSTReject a KYC document
/kyc-documents/:id/rejectionMarks that status of the document as rejected. Updates the review time and reviewer information. Intended to be used for manual overrides. - POSTReview a KYC document
/kyc-documents/:id/reviewMark the KYC document as reviewed. Updates the review time and reviewer. information. - GETRetrieve a list of KYC requests
/kyc-requests?limit=0&offset=0&filter=string&sort=stringRetrieve a list of KYC requests. - POSTCreate a KYC Request
/kyc-requestsCreate a KYC Request. - GETRetrieve a KYC request
/kyc-requests/:idRetrieve a KYC request with specified identifier string. - DELETEDelete the KYC request
/kyc-requests/:idDelete the KYC request with the predefined identifier string. - PATCHUpdate a KYC request
/kyc-requests/:idUpdate a KYC request.
Customer Authentication
- GETRead current authentication options
/authentication-optionsRead current authentication options. - PUTChange authentication options
/authentication-optionsChange options. - GETRetrieve a list of auth tokens
/authentication-tokens?limit=0&offset=0Retrieve a list of auth tokens. - POSTLogin
/authentication-tokensLogin a customer. - GETVerify
/authentication-tokens/:tokenVerify an authentication token. - DELETELogout a customer
/authentication-tokens/:tokenLogout a customer. - POSTExchange
/authentication-tokens/:token/exchangeExchange Authentication Token for JWT. It will also invalidate an Authentication Token by default (so it can only be exchanged once). - GETRetrieve a list of credentials
/credentials?limit=0&offset=0Retrieve a list of credentials. - POSTCreate a credential
/credentialsCreate a credential. - GETRetrieve a credential
/credentials/:idRetrieve a credential with specified identifier string. - PUTCreate or update a credential with predefined ID
/credentials/:idCreate or update a credential with predefined identifier string. - DELETEDelete a credential
/credentials/:idDelete a credential with predefined identifier string. - GETRetrieve a list of tokens
/password-tokens?limit=0&offset=0Retrieve a list of tokens. - POSTCreate a Reset Password Token
/password-tokensCreate a Reset Password Token. - GETRetrieve a Reset Password Token
/password-tokens/:idRetrieve a Reset Password Token with specified identifier string. - DELETEDelete a Reset Password Token
/password-tokens/:idDelete a Reset Password Token with predefined identifier string.
Custom Fields
- GETRetrieve Custom Fields
/custom-fields/:resource?limit=0&offset=0Retrieve a schema of Custom Fields for the given resource type. - GETRetrieve a Custom Field
/custom-fields/:resource/:nameRetrieve a schema of the given Custom Field for the given resource type. - PUTCreate or alter a Custom Field
/custom-fields/:resource/:nameCreate or alter a schema of the given Custom Field for the given resource. type.
Disputes
- GETRetrieve a list of disputes
/disputes?filter=string&sort=string&limit=0&offset=0&q=string&expand=stringRetrieve a list of disputes. - POSTCreate a dispute
/disputesCreate a dispute. - GETRetrieve a dispute
/disputes/:idRetrieve a dispute with specified identifier string. - PUTCreate or update a Dispute with predefined ID
/disputes/:idCreate or update a Dispute with predefined identifier string.
Files
- GETRetrieve a list of Attachments
/attachments?limit=0&offset=0&filter=string&q=string&expand=string&fields=string&sort=stringRetrieve a list of attachments. You may sort by the id, name, relatedId, relatedType, fileId, createdTime, and updatedTime. - POSTCreate an Attachment
/attachmentsCreate an Attachment. - GETRetrieve an Attachment
/attachments/:idRetrieve a Attachment with specified identifier string. - PUTUpdate the Attachment with predefined ID
/attachments/:idUpdate the Attachment with predefined ID. - DELETEDelete an Attachment
/attachments/:idDelete the Attachment with predefined identifier string. - GETRetrieve a list of files
/files?limit=0&offset=0&filter=string&q=string&expand=string&fields=string&sort=stringRetrieve a list of files. - POSTCreate a file
/filesAdditionally, a file can be sent with:. multipart/form-data POST request: in this case all property names are the same as the JSON ones (file is an uploaded… - GETRetrieve a File Record
/files/:idRetrieve a File with specified identifier string. - PUTUpdate the File with predefined ID
/files/:idUpdate the File with predefined ID. Note that file can be uploaded with POST. only. - DELETEDelete a File
/files/:idDelete the File with predefined identifier string. - GETDownload a file
/files/:id/download?imageSize=700x700Download a file. - GETDownload image in specific format
/files/:id/download:extensionDownload image in specific format. Images are converted server-side.
Invoices
- GETRetrieve customer's upcoming invoices
/customers/:id/upcoming-invoices?expand=stringRetrieve a list of upcoming invoices from the subscriptions which belong to. the given customer. The endpoint is temporary before upcoming invoices get a… - GETRetrieve a list of invoices
/invoices?filter=string&sort=string&limit=0&offset=0&q=string&expand=stringRetrieve a list of invoices. - POSTCreate an invoice
/invoicesCreate an invoice. - GETRetrieve an invoice
/invoices/:id?expand=stringRetrieve an invoice with specified identifier string. - PUTCreate or update an invoice with predefined ID
/invoices/:idCreate or update an invoice with predefined identifier string. - POSTAbandon an invoice
/invoices/:id/abandonAbandon an invoice with specified identifier string. - POSTIssue an invoice
/invoices/:id/issueIssue an invoice with specified identifier string. It must be in draft status. - GETRetrieve invoice items
/invoices/:id/items?limit=0&offset=0&expand=stringRetrieve an invoice items with specified invoice identifier string. - POSTCreate an invoice item
/invoices/:id/itemsCreate an invoice item. - POSTRecalculate an invoice
/invoices/:id/recalculateRecalculate an invoice with specified identifier string. It will recalculate shipping rates, taxes, discounts. It is useful when coupon was revoked or… - POSTReissue an invoice
/invoices/:id/reissueReissue an invoice with specified identifier string. It must be issued. (status must be unpaid or past-due). - GETRetrieve a list of invoice timeline messages
/invoices/:id/timeline?limit=0&offset=0&filter=string&sort=string&q=stringRetrieve a list of invoice timeline messages. - POSTCreate an invoice Timeline comment
/invoices/:id/timelineCreate an invoice Timeline comment. - GETRetrieve an Invoice Timeline message
/invoices/:id/timeline/:messageIdRetrieve a invoice message with specified identifier string. - DELETEDelete an Invoice Timeline message
/invoices/:id/timeline/:messageIdDelete an Invoice Timeline message with predefined identifier string. - POSTApply a transaction to an invoice
/invoices/:id/transactionApply a transaction to an invoice. The invoice must be unpaid. The transaction must have a non-zero unused amount (not fully applied to other invoices). - GETGet transaction amounts allocated to an invoice
/invoices/:id/transaction-allocations?limit=0&offset=0Get the precise amounts from a transaction allocated as invoice payments. - POSTVoid an invoice
/invoices/:id/voidVoid an invoice with specified identifier string.
Payment Instruments
- GETRetrieve a list of payment instruments
/payment-instruments?filter=string&sort=string&limit=0&offset=0&q=string&expand=stringRetrieve a list of payment instruments. - POSTCreate a Payment Instrument
/payment-instrumentsCreate a payment instrument. If such payment card or bank account payment instrument already exists then updates it instead. - GETRetrieve a Payment Instrument
/payment-instruments/:idRetrieve a payment instrument by ID. - PATCHUpdate a Payment Instrument's values
/payment-instruments/:idUpdate allowed payment instrument's values. - POSTDeactivate a payment instrument
/payment-instruments/:id/deactivationDeactivate a payment instrument.
Payment Cards
- GETRetrieve a list of Payment Cards
/payment-cards?limit=0&offset=0&filter=string&sort=string&q=string&expand=stringRetrieve a list of Payments Cards. - POSTCreate a Payment Card
/payment-cardsCreate a Payment Card. - GETRetrieve a Payment Card
/payment-cards/:idRetrieve a Payment Card with specified identifier string. - PUTCreate a payment card with predefined ID
/payment-cards/:id - PATCHUpdate a payment card's values
/payment-cards/:idUpdate any of the payment card's values except for the pan. - POSTDeactivate a Payment Card
/payment-cards/:id/deactivationDeactivate a Payment Card.
PayPal Accounts
- GETRetrieve a list of PayPal accounts
/paypal-accounts?filter=string&sort=string&limit=0&offset=0&q=string&expand=stringRetrieve a list of PayPal Accounts. - POSTCreate a PayPal Account
/paypal-accountsCreate a PayPal Account. - GETRetrieve a PayPal Account
/paypal-accounts/:idRetrieve a PayPal Account with specified identifier string. - PUTCreate a PayPal account with predefined ID
/paypal-accounts/:id - POSTDeactivate a PayPal Account
/paypal-accounts/:id/deactivationDeactivate a PayPal Account.
Payment Tokens
- POSTValidate a digital wallet session
/digital-wallets/validationFramePay is the recommended way to use when validating a digital wallet session. - GETRetrieve a list of tokens
/tokens?limit=0&offset=0Retrieve a list of tokens. - POSTCreate a payment token
/tokensFramePay is the recommended way to create a payment token because it minimizes PCI DSS compliance. Once a payment token is created, it can only be used once.… - GETRetrieve a token
/tokens/:tokenRetrieve a token with specified identifier string.
Plans
- GETRetrieve a list of plans
/plans?filter=string&sort=string&limit=0&offset=0&q=stringRetrieve a list of plans. - POSTCreate a plan
/plansCreate a plan. - GETRetrieve a plan
/plans/:idRetrieve a plan with specified identifier string. - PUTCreate or update a Plan with predefined ID
/plans/:idCreate or update a Plan with predefined identifier string. - DELETEDelete a Plan
/plans/:idDelete a Plan with predefined identifier string.
Products
- GETRetrieve a list of products
/products?filter=string&sort=string&limit=0&offset=0&q=stringRetrieve a list of products. - POSTCreate a Product
/productsCreate a Product. - GETRetrieve a product
/products/:idRetrieve a product with specified identifier string. - PUTCreate a product with predefined ID
/products/:idCreate a product with predefined identifier string. - DELETEDelete a product
/products/:idDelete a product with predefined identifier string.
Search
- GETSearch merchant data
/search?sort=string&limit=0&offset=0&q=stringSearch merchant's data to return resources such as customers, invoices, orders, transactions.
Shipping Zones
- GETRetrieve a list of shipping zones
/shipping-zones?limit=0&offset=0&filter=string&sort=string&q=stringRetrieve a list of shipping zones. - POSTCreate a Shipping Zone
/shipping-zonesCreate a Shipping Zone. - GETRetrieve a shipping zone
/shipping-zones/:idRetrieve a shipping zone with specified identifier string. - PUTCreate a shipping zone with predefined ID
/shipping-zones/:idCreate a shipping zone with predefined identifier string. - DELETEDelete a shipping zone
/shipping-zones/:idDelete a shipping zone with predefined identifier string.
Orders
- GETRetrieve a list of cancellations
/subscription-cancellations?limit=0&offset=0&filter=string&sort=stringRetrieve a list of cancellations for all subscriptions. - POSTCancel an order
/subscription-cancellationsCancel an order or preview the cancellation parameters before that. - GETRetrieve an order сancellation
/subscription-cancellations/:idRetrieve an order сancellation with specified identifier string. - PUTCancel an order
/subscription-cancellations/:idCancel a subscription. - DELETEDelete a cancellation
/subscription-cancellations/:idDelete an order's cancellation. Only draft can be deleted. - GETRetrieve a list of reactivations
/subscription-reactivations?limit=0&offset=0&filter=string&sort=stringRetrieve a list of reactivations for all subscriptions. - POSTReactivate an order
/subscription-reactivationsReactivate a subscription. - GETRetrieve an order reactivation
/subscription-reactivations/:idRetrieve an order reactivation with specified identifier string. - GETRetrieve a list of orders
/subscriptions?filter=string&sort=string&limit=0&offset=0&q=string&expand=stringRetrieve a list of orders. - POSTCreate an order
/subscriptions?expand=stringCreate an order. Consider using the upsert. operation to accomplish this task. - GETRetrieve an order
/subscriptions/:id?expand=stringRetrieve an order with specified identifier string. - PUTUpsert an order with predefined ID
/subscriptions/:id?expand=stringCreate or update an order with predefined identifier string. - POSTChange an order's items
/subscriptions/:id/change-itemsChange an order's items or quantities and designate when and if there should be pro-rata credits given. - POSTIssue an interim invoice for a subscription order
/subscriptions/:id/interim-invoiceIssue an interim invoice for a subscription, typically used in conjunction. with plan changes and pro rata adjustments. This process creates an invoice, adds… - GETRetrieve a list of order timeline messages
/subscriptions/:id/timeline?limit=0&offset=0&filter=string&sort=string&q=stringRetrieve a list of order timeline messages. - POSTCreate an order Timeline comment
/subscriptions/:id/timelineCreate an order Timeline comment. - GETRetrieve an Order Timeline message
/subscriptions/:id/timeline/:messageIdRetrieve a order message with specified identifier string. - DELETEDelete an Order Timeline message
/subscriptions/:id/timeline/:messageIdDelete an Order Timeline message with predefined identifier string. - GETRetrieve subscription order's upcoming invoice
/subscriptions/:id/upcoming-invoices?expand=stringRetrieve an upcoming invoice from the specified subscription order. The endpoint is temporary before upcoming invoices get a complete integration. - POSTIssue an upcoming invoice for early pay
/subscriptions/:id/upcoming-invoices/:invoiceId/issueIssue an upcoming invoice with specified identifier string for early pay.
Tags
- GETRetrieve a list of tags
/tags?limit=0&offset=0&filter=string&q=string&sort=stringRetrieve a list of tags. - POSTCreate a tag
/tagsCreate a tag. - GETRetrieve a tag
/tags/:tagRetrieve a tag. - DELETEDelete a tag
/tags/:tagDelete a tag. It's an asynchronous operation. - PATCHUpdate a tag
/tags/:tagUpdate a tag. - POSTTag a list of customers
/tags/:tag/customersTag a list of customers. If the customer from the list is already tagged it will be ignored. It's an asynchronous operation. - DELETEUntag a list of customers
/tags/:tag/customersUntag a list of customers. If the customer from the list is already untagged it will be ignored. It's an asynchronous operation. - POSTTag a customer
/tags/:tag/customers/:customerIdTag a customer. - DELETEUntag a customer
/tags/:tag/customers/:customerIdUntag a customer.
Transactions
- POSTCreate a credit transaction
/payoutsCreate a transaction of type credit. - POSTReady to Pay
/ready-to-payGet available payment methods for a specific transaction or a purchase. The payment methods order shown to a customer SHOULD be the same as the order in the… - GETRetrieve a list of transactions
/transactions?limit=0&offset=0&filter=string&q=string&sort=string&expand=stringRetrieve a list of transactions. - POSTCreate a transaction
/transactions?expand=stringCreate a transaction of type sale or authorize. This endpoint supports two main styles of transactions: 1. A real-time decision and response. 2. User… - GETRetrieve a Transaction
/transactions/:id?expand=stringRetrieve a Transaction with specified identifier string. - PATCHUpdate a transaction
/transactions/:idUpdate a transaction's custom fields. - POSTQuery a Transaction
/transactions/:id/queryQuery a Transaction with a specified identifier string. The query will contact the gateway account to find the result and amount/currency. The response should… - POSTRefund a Transaction
/transactions/:id/refundRefund a Transaction with specified identifier string. Note that the refund will be in the same currency as the original transaction. - GETRetrieve a list of transaction timeline messages
/transactions/:id/timeline?limit=0&offset=0&filter=stringRetrieve a list of transaction timeline messages. - POSTCreate a transaction Timeline comment
/transactions/:id/timelineCreate a transaction Timeline comment. - GETRetrieve a transaction Timeline message
/transactions/:id/timeline/:messageIdRetrieve a timeline message with specified identifier string. - DELETEDelete a Transaction Timeline message
/transactions/:id/timeline/:messageIdDelete a Transaction Timeline message with predefined identifier string. - POSTUpdate a Transaction status
/transactions/:id/updateUpdate a Transaction manually to completed status with given result with optional currency and amount.
API details
- Base URL
https://api-sandbox.rebilly.comhttps://api.rebilly.com- Authentication
- A bearer token in the Authorization header
An API key in the Authorization header
An API key in the REB-APIKEY header - Operations
- 184 operations on 105 pathsGET 77POST 61PUT 20DELETE 20PATCH 6
- Main resources
- Orders 20Invoices 18Customer Authentication 16KYC Documents 13Transactions 13Files 12Coupons 9Customers 9Tags 9Customers Timeline 7
- Response formats
application/jsonapplication/pdf- Description format
- OpenAPI 3.0.3, API version
2.1 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Rebilly REST API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Rebilly REST API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieve a list of ThreeDSecure entries” (GET /3dsecure?limit=0&offset=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Rebilly REST API?
Introduction The Rebilly API is built on HTTP. Our API is RESTful. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It… It is listed under Payments and has 184 endpoints.
Who publishes the Rebilly REST API?
It is listed from Rebilly's public API description (an OpenAPI document), not published by Rebilly on Swastik Codes. Anyone who controls rebilly.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Rebilly REST API?
Its description lists 2 base URLs: https://api-sandbox.rebilly.com, https://api.rebilly.com. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Rebilly REST API?
It accepts 3 methods: A bearer token in the Authorization header; an API key in the Authorization header; an API key in the REB-APIKEY header.
How many endpoints does the Rebilly REST API have?
184 operations on 105 paths (77 GET, 61 POST, 20 PUT, 20 DELETE, 6 PATCH). The largest groups are Orders, Invoices, Customer Authentication, KYC Documents.
Is forking the Rebilly REST API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.