Developer docs
/
Rebilly API
/
Payment instruments
/
Retrieve payment instruments

Core APIs (latest)

Introduction

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.

Authentication

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.

  • Secret API key: Use to make requests from the server side. Never share these keys. Keep them guarded and secure.
  • Publishable API key: Use in your client-side code to tokenize payment information.
  • JWT: Use to make short-life tokens that expire after a set period of time.

Manage API keys

To create or manage API keys, select one of the following:

For more information on API keys, see API keys.

Errors

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.

SDKs

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.

JavaScript SDK

For installation and usage instructions, see SDKs. All JavaScript SDK code examples are included in the API reference documentation.

PHP SDK

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',
]);

Get started

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.

To create and manage API keys, see API keys.

Rate limits

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.

Download OpenAPI description
index.json
index.yaml
Overview
URL https://www.rebilly.com/contact/
Rebilly API Support integrations@rebilly.com
License Rebilly
 Terms of Service
Languages
Servers
Mock server
https://www.rebilly.com/_mock/docs/dev-docs/api/
Sandbox server
https://api-sandbox.rebilly.com/organizations/{organizationId}/
Live server
https://api.rebilly.com/organizations/{organizationId}/

Customers

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.

Operations

Customer authentication

Use these operations to validate the identity of users and manage authentication credentials.

Operations

Tags

Use tags to organize and categorize customers or KYC documents based on keywords.

Operations

Customers timeline

Use customer timelines to maintain an audit trail of changes and activity for each customer.

Operations

Payment instruments

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.

OperationsWebhooks

Retrieve payment instruments

Request

Retrieves a list of payment instruments.

Query
filterstring

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.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

limitinteger[ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger[ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

qstring

Use this field to perform a partial search of text fields.

expandstring

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/payment-instruments?expand=string&filter=string&limit=1000&offset=1000&q=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of payment instruments retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example: 332
Pagination-Limitinteger

Maximum number of items per page.

Example: 100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Bodyapplication/jsonArray [
idstring<= 50 charactersread-only

ID of the payment instrument.

Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
customerIdstring(CustomerId)<= 50 characters

ID of the customer resource.

methodstringread-onlyrequired

Method of payment instrument.

Value"payment-card"
Discriminator
statusstring

Status of the payment instrument. An active status means that a payment instrument has been used at least once for an approved transaction. To remove an instrument from use, set this value to deactivated.

For more information, see Deactivate a payment instrument.

Enum"active""inactive""expired""deactivated""verification-needed"
fingerprintstringread-only

Unique value that is used to identify the payment instrument. This value is generated from the bin and the last4 values. This value contains alphanumeric characters.

binstring(bin)read-only

Bank Identification Number (BIN) of the payment card. This value is the same as the first 6 digits of the associated Primary Account Number (PAN).

last4stringread-only

Last 4 digits of the associated Primary Account Number (PAN).

expYearinteger

Expiration year of the payment card.

expMonthinteger

Expiration month of the payment card.

brandstringread-only

Brand of payment card.

Enum"Visa""MasterCard""American Express""Discover""Maestro""Solo""Electron""JCB""Voyager""Diners Club"
bankCountrystring or nullread-only

Bank country of the payment instrument.

bankNamestringread-only

Bank name of the payment instrument.

billingAddressobject(ContactObject)

Contact's billing address.

useAsBackupboolean(UseAsBackup)

Specifies if this payment instrument can be used as a backup for invoice payment retries.

billingPortalUrlstringread-only

URL of the billing portal where the card can be updated.

createdTimestring(date-time)(CreatedTime)read-only

Date and time which is set automatically when the resource is created.

updatedTimestring(date-time)(UpdatedTime)read-only

Date and time which updates automatically when the resource is updated.

customFieldsobject(ResourceCustomFields)

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.

stickyGatewayAccountIdstring or nullread-only

ID of the sticky gateway account. All future payments are processed by this gateway account.

For more information, see Gateway routing.

expirationReminderTimestring or null(date-time)read-only

Date and time when an expiration reminder event is triggered.

expirationReminderNumberinteger or nullread-only

Number of expiration reminder events that have triggered.

referenceDataobject

Payment instrument reference data.

Example: {"gatewayTransactionId":"GAT123"}
digitalWalletstring or nullread-only

Digital wallet type.

Enum"Apple Pay""Google Pay""Samsung Pay"null
riskMetadataRisk metadata (object) or null
One of:

Risk metadata used for 3D Secure and risk scoring.

revisionintegerread-only

Number of times the payment instrument data has been modified.

Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.

_linksArray of objectsread-only

Related links.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
application/json
[
  {
    "id": "inst_0YVB8KPKNXCBR9EDX7JHSED75N",
    "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
    "method": "payment-card",
    "status": "active",
    "fingerprint": "string",
    "bin": "string",
    "last4": "string",
    "expYear": 0,
    "expMonth": 0,
    "brand": "Visa",
    "bankCountry": "string",
    "bankName": "string",
    "billingAddress": { … },
    "useAsBackup": false,
    "billingPortalUrl": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "customFields": { … },
    "stickyGatewayAccountId": "string",
    "expirationReminderTime": "2019-08-24T14:15:22Z",
    "expirationReminderNumber": 0,
    "referenceData": { … },
    "digitalWallet": "Apple Pay",
    "riskMetadata": { … },
    "revision": 0,
    "_links": [ … ],
    "_embedded": { … }
  }
]

Create a payment instrument

Request

Creates a payment instrument. If the payment card, bank account, or alternative payment instrument already exists it is updated.

Bodyapplication/jsonrequired

PaymentInstrument resource.

Any of:
customerIdstring(CustomerId)<= 50 charactersrequired

ID of the customer resource.

tokenstringrequired

ID of the payment token.

customFieldsobject(ResourceCustomFields)

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.

useAsBackupboolean(UseAsBackup)

Specifies if this payment instrument can be used as a backup for invoice payment retries.

curl -i -X POST \
  https://www.rebilly.com/_mock/docs/dev-docs/api/payment-instruments \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
    "token": "string",
    "customFields": {
      "foo": "bar"
    },
    "useAsBackup": false
  }'

Responses

Payment instrument created.

Headers
Locationstring(uri)

Location of the related resource.

Example: "https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example: 3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example: 3600
Bodyapplication/json
idstring<= 50 charactersread-only

ID of the payment instrument.

Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
customerIdstring(CustomerId)<= 50 characters

ID of the customer resource.

methodstringread-onlyrequired

Method of payment instrument.

Value"payment-card"
Discriminator
statusstring

Status of the payment instrument. An active status means that a payment instrument has been used at least once for an approved transaction. To remove an instrument from use, set this value to deactivated.

For more information, see Deactivate a payment instrument.

Enum"active""inactive""expired""deactivated""verification-needed"
fingerprintstringread-only

Unique value that is used to identify the payment instrument. This value is generated from the bin and the last4 values. This value contains alphanumeric characters.

binstring(bin)read-only

Bank Identification Number (BIN) of the payment card. This value is the same as the first 6 digits of the associated Primary Account Number (PAN).

last4stringread-only

Last 4 digits of the associated Primary Account Number (PAN).

expYearinteger

Expiration year of the payment card.

expMonthinteger

Expiration month of the payment card.

brandstringread-only

Brand of payment card.

Enum"Visa""MasterCard""American Express""Discover""Maestro""Solo""Electron""JCB""Voyager""Diners Club"
bankCountrystring or nullread-only

Bank country of the payment instrument.

bankNamestringread-only

Bank name of the payment instrument.

billingAddressobject(ContactObject)

Contact's billing address.

useAsBackupboolean(UseAsBackup)

Specifies if this payment instrument can be used as a backup for invoice payment retries.

billingPortalUrlstringread-only

URL of the billing portal where the card can be updated.

createdTimestring(date-time)(CreatedTime)read-only

Date and time which is set automatically when the resource is created.

updatedTimestring(date-time)(UpdatedTime)read-only

Date and time which updates automatically when the resource is updated.

customFieldsobject(ResourceCustomFields)

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.

stickyGatewayAccountIdstring or nullread-only

ID of the sticky gateway account. All future payments are processed by this gateway account.

For more information, see Gateway routing.

expirationReminderTimestring or null(date-time)read-only

Date and time when an expiration reminder event is triggered.

expirationReminderNumberinteger or nullread-only

Number of expiration reminder events that have triggered.

referenceDataobject

Payment instrument reference data.

Example: {"gatewayTransactionId":"GAT123"}
digitalWalletstring or nullread-only

Digital wallet type.

Enum"Apple Pay""Google Pay""Samsung Pay"null
riskMetadataRisk metadata (object) or null
One of:

Risk metadata used for 3D Secure and risk scoring.

revisionintegerread-only

Number of times the payment instrument data has been modified.

Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.

_linksArray of objectsread-only

Related links.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

Response
application/json