Edge API (v1)

Download OpenAPI specification:Download

Support: support@tryedge.io URL: https://www.tryedge.io/contact Terms of Service

Edge Payment Technologies offers payment solutions for merchants in diverse legal industries. To learn more about Edge's proposition see our about page.

Before starting with the API, you must create a merchant account and obtain API keys from the Developer tab in your account dashboard. You will use the “Publishable key” with Edge JavaScript SDK and the “Secret key” on your website.

The Edge API is based upon REST principles, returns JSON responses, and uses standard HTTP response codes. We speficially use the JSON:API specification.

If you're wanting to use Edge Payment Technologies in the browser to make a charge you're going to need to include the Edge javascript SDK. The Edge JavaScript SDK is a toolkit for encrypting data in the browser. Using the Edge JavaScript SDK means your customer's data never leaves their browser unencrypted. Include this in your HTML:

<script
  src="https://assets.tryedge.io/assets/edge-028df78616a38778a73b92faac46bd2d5b1d4f3734f2902cc7d8548a0b7ffa4d.js"
  type="text/javascript"></script>

Then after that you need to initialize the client:

const edge = new Edge('<Publishable Key>');

edge.initializeForm().then(function (form) {
  // Form configuration
});

Authentication

The Edge API relies on authentication via public and secret keys:

  • For environments exposed to the public (such as browsers) use your public key
  • For server to server communication use your secret key

To authenticate a request set the Authorization header to Bearer <YOUR_TOKEN_HERE>.

Edge.js

The Edge JavaScript SDK on intializeForm() exposes a form builder. The main function exposed by the form builder is the inputs function (form.inputs(…)). It initialises Edge Inputs, making it easy to collect encrypted cardholder data in a completely PCI-compliant environment.

Edge Inputs are served within an iFrame retrieved directly from Edge’s PCI-compliant infrastructure, which can reduce your PCI DSS compliance scope to the simplest form (SAQ-A) once integrated correctly.

Pass the id of the element in which the iFrame should be embedded, for example:

// form.inputs(id: String, settings: Object);
form.inputs('card-details', {
  theme: 'material'
});

Themes

Inputs can be customized to match your brand’s design system. The Edge JavaScript SDK allows additional configuration for styling both the Evervault Inputs container as well as each <input> within the container.

Supported Settings

Parameter Type Description
theme String The base styling for Inputs. Currently supports default, minimal and material.
height String The height of the Evervault Inputs iframe.
primaryColor String The main theme color.
labelColor String The color CSS property applied to the input labels.
inputBorderColor String The border-color CSS property applied to inputs.
inputTextColor String The color CSS property applied to inputs.
inputBackgroundColor String The color CSS property applied to the ::placeholder CSS pseudo-element for inputs.
inputBorderRadius String The border-radius CSS property applied to inputs.
inputHeight String The height CSS property applied to inputs.
cardNumberLabel String The label for the card number input
expirationDateLabel String The label for the expiration date input
securityCodeLabel String The label for the security code input
expirationDatePlaceholder String The placeholder shown for the expiration date input
invalidCardNumberLabel String The message shown on an invalid card number
invalidExpirationDateLabel String The message shown on an invalid expiration date
invalidSecurityCodeLabel String The message shown on an invalid security code
fontUrl String Load a custom font with the Google Fonts API
fontFamily String Set the font-family for the fontUrl
inputFontSize String Set the font-size property of the input attribute
inputBoxShadow String Set the box-shadow property of the input attribute
labelFontSize String Set the font-size property of the label attribute
labelWeight String Set the font-weight property of the label attribute
disableCVV Boolean If true the CVV field will not be displayed

Default Theme

Set theme to default to use the Default theme for Inputs.

Screenshot 2023-04-10 at 09.54.34.png

Minimal Theme

Set theme to minimal to use the Minimal theme for Inputs.

Screenshot 2023-04-10 at 09.56.04.png

Material Theme

Set theme to material to use the Material theme for Inputs.

Merchant Accounts

Details

MerchantAccount is your organization on Edge. Edge periodically reviews the accuracy of the information provided, and keeping your merchant account profile up-to-date is essential. You can manage this information on the merchant dashboard and through the API.

List of Merchant Accounts

Lists all Merchant Accounts

SecuritybearerAuth
Request
query Parameters
fields[consumer_addresses]
Array of strings
Example: fields[consumer_addresses]=id,created_at,updated_at
fields[customers]
Array of strings
Example: fields[customers]=id,created_at,updated_at
fields[events]
Array of strings
Example: fields[events]=id,created_at,updated_at
fields[payouts]
Array of strings
Example: fields[payouts]=id,created_at,updated_at
fields[payment_methods]
Array of strings
Example: fields[payment_methods]=id,created_at,updated_at
fields[charges]
Array of strings
Example: fields[charges]=id,created_at,updated_at
fields[subscriptions]
Array of strings
Example: fields[subscriptions]=id,created_at,updated_at
fields[webhook_subscriptions]
Array of strings
Example: fields[webhook_subscriptions]=id,created_at,updated_at
fields[payout_methods]
Array of strings
Example: fields[payout_methods]=id,created_at,updated_at
include
Array of strings
Example: include=a,a.b,c,c.d.e
filter[average_monthly_transaction_volume_cents]
string
filter[average_transaction_size_cents]
string
filter[business_address]
string
filter[business_address_line_2]
string
filter[business_city_name]
string
filter[business_country]
string
filter[business_description]
string
filter[business_name]
string
filter[business_privacy_url]
string
filter[business_state]
string
filter[business_support_email]
string
filter[business_support_url]
string
filter[business_terms_url]
string
filter[business_timezone]
string
filter[business_website]
string
filter[business_zip_code]
string
filter[max_transaction_size_cents]
string
filter[phone_number]
string
filter[public_business_name]
string
filter[shortened_descriptor]
string
filter[statement_descriptor]
string
Responses
200

OK

401

Unauthorized

403

Forbidden

406

Not Acceptable

get/merchant_accounts
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Merchant Account


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[consumer_addresses]
Array of strings
 
 Example:  fields[consumer_addresses]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[payouts]
Array of strings
 
 Example:  fields[payouts]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[subscriptions]
Array of strings
 
 Example:  fields[subscriptions]=id,created_at,updated_at
fields[webhook_subscriptions]
Array of strings
 
 Example:  fields[webhook_subscriptions]=id,created_at,updated_at
fields[payout_methods]
Array of strings
 
 Example:  fields[payout_methods]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/merchant_accounts/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Update
Updates an existing Merchant Account


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[consumer_addresses]
Array of strings
 
 Example:  fields[consumer_addresses]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[payouts]
Array of strings
 
 Example:  fields[payouts]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[subscriptions]
Array of strings
 
 Example:  fields[subscriptions]=id,created_at,updated_at
fields[webhook_subscriptions]
Array of strings
 
 Example:  fields[webhook_subscriptions]=id,created_at,updated_at
fields[payout_methods]
Array of strings
 
 Example:  fields[payout_methods]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


406
Not Acceptable


patch/merchant_accounts/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Charges
A Charge instance signifies an attempt to transfer money from a customer's payment method to your Edge merchant account.


A charge optionally belongs to a customer, but it is recommended to associate a charge with the customer. Customer charge history can be used as evidence in case of a chargeback or dispute.


Sale


A “sale” is denoted by having a charge created with the captured attribute as true (default). In this case, the charge would start its lifecycle in a pending state and immediately get sent for processing. Its processor_state would then transit to succeeded or failed.


Pre-authorization / completion flow


Pre-authorization holds a certain amount from the customer's card. Such requests should be completed within 2 days time, or the hold will be removed.


You can opt into a pre-authorization by creating a charge with the captured attribute set to false. Then to capture the charge, you would update the charge with a value equal to or less than the value provided when creating the charge.


Refund a charge


TOOD


Events


A charge through its lifecycle will emit events. You can listen to these events as webhooks through WebhookSubscription.


    

  • charge.created
    • 

  • charge.updated
    • 

  • charge.refunded
    • 

  • charge.succeeded
    • 

  • charge.failed
    • 

  • charge.disputed
    • 

  • charge.deleted
    • 



List of Charges
Lists all Charges


SecuritybearerAuth 
Request 
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
fields[billing_addresses]
Array of strings
 
 Example:  fields[billing_addresses]=id,created_at,updated_at
fields[subscriptions]
Array of strings
 
 Example:  fields[subscriptions]=id,created_at,updated_at
fields[shipping_addresses]
Array of strings
 
 Example:  fields[shipping_addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[amount_cents]
string
 
filter[captured]
string
 
filter[currency]
string
 
filter[description]
string
 
filter[fee_cents]
string
 
filter[gateway_fee_cents]
string
 
filter[net_cents]
string
 
filter[processor_state]
string
 
filter[refund_amount_cents]
string
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/charges
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create
Creates an new Charge


SecuritybearerAuth 
Request 
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
fields[billing_addresses]
Array of strings
 
 Example:  fields[billing_addresses]=id,created_at,updated_at
fields[subscriptions]
Array of strings
 
 Example:  fields[subscriptions]=id,created_at,updated_at
fields[shipping_addresses]
Array of strings
 
 Example:  fields[shipping_addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


401
Unauthorized


403
Forbidden


406
Not Acceptable


415
Unsupported Media Type


422
Unprocessible Entity


post/charges
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Charge


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
fields[billing_addresses]
Array of strings
 
 Example:  fields[billing_addresses]=id,created_at,updated_at
fields[subscriptions]
Array of strings
 
 Example:  fields[subscriptions]=id,created_at,updated_at
fields[shipping_addresses]
Array of strings
 
 Example:  fields[shipping_addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/charges/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Subscriptions
Subscriptions allow you to charge customers recurringly for access to a product or service. Edge supports subscriptions with billing cycles weekly, biweekly, monthly, bimonthly, quarterly, semiannual, and yearly. Edge will create a new charge against the associated payment method when a new cycle begins.


Events


You can listen to subscriptions.created, subscription.updated and subscription.deleted events on the resource. In addition, charges would trigger their respective events as they advance through their lifecycle.


Detecting Failures


A subscription will be in an active status unless specified otherwise. However, the customer may have entered the card details incorrectly. In this case, the subscription status will transit from active to past_due. Track this transition using WebhookSubscription by listening to the subscription.updated event.


List of Subscriptions
Lists all Subscriptions


SecuritybearerAuth 
Request 
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[amount_cents]
string
 
filter[amount_currency]
string
 
filter[billing_period]
string
 
filter[description]
string
 
filter[next_billing_day]
string
 
filter[status]
string
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/subscriptions
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create
Creates an new Subscription


SecuritybearerAuth 
Request 
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


401
Unauthorized


403
Forbidden


406
Not Acceptable


415
Unsupported Media Type


422
Unprocessible Entity


post/subscriptions
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Subscription


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/subscriptions/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Update
Updates an existing Subscription


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


406
Not Acceptable


patch/subscriptions/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Payment Methods
Use the PaymentMethod API to store customer credit/debit card details for immediate (charges) or later processing (subscriptions). The API does not accept raw card numbers or cvv values. Edge JS will provide tokenised values for card numbers (card_pan_token) and cvv (card_cvv_token).


Edge currently supports credit and debit cards of Visa, Master, AMEX and Discovery. Edge intends to introduce support for ACH payments soon.


List of Payment Methods
Lists all Payment Methods


SecuritybearerAuth 
Request 
query Parameters
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[addresses]
Array of strings
 
 Example:  fields[addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[card_bin]
string
 
filter[card_cvv_token]
string
 
filter[card_last_four]
string
 
filter[card_pan_token]
string
 
filter[description]
string
 
filter[external_state]
string
 
filter[kind]
string
 
filter[name]
string
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/payment_methods
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create
Creates an new Payment Method


SecuritybearerAuth 
Request 
query Parameters
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[addresses]
Array of strings
 
 Example:  fields[addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


401
Unauthorized


403
Forbidden


406
Not Acceptable


415
Unsupported Media Type


422
Unprocessible Entity


post/payment_methods
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Payment Method


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[customers]
Array of strings
 
 Example:  fields[customers]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[addresses]
Array of strings
 
 Example:  fields[addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/payment_methods/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Payout Methods
PayoutMethod lets you link your bank account with Edge to receive payouts. Edge handles payouts through ACH and supports checking and savings accounts.


Events


Currently, there are no events triggered during the lifecycle of payouts.


List of Payout Methods
Lists all Payout Methods


SecuritybearerAuth 
Request 
query Parameters
fields[payouts]
Array of strings
 
 Example:  fields[payouts]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[account_number]
string
 
filter[account_type]
string
 
filter[institution_name]
string
 
filter[payout_method_type]
string
 
filter[routing_number]
string
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/payout_methods
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create
Creates an new Payout Method


SecuritybearerAuth 
Request 
query Parameters
fields[payouts]
Array of strings
 
 Example:  fields[payouts]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


401
Unauthorized


403
Forbidden


406
Not Acceptable


415
Unsupported Media Type


422
Unprocessible Entity


post/payout_methods
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Payout Method


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[payouts]
Array of strings
 
 Example:  fields[payouts]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/payout_methods/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Payouts
Payout lets you withdraw your earnings to a bank account (denoted by a PayoutMethod) periodically or manually as needed. Your ability to trigger a payout depends on your industry and perceived risks. Edge may need to implement a rolling reserve for merchants perceived as high-risk, which may delay your ability to trigger payouts until the reserve requirements are met.


List of Payouts
Lists all Payouts


SecuritybearerAuth 
Request 
query Parameters
fields[payout_methods]
Array of strings
 
 Example:  fields[payout_methods]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[amount_cents]
string
 
filter[amount_currency]
string
 
filter[fee_cents]
string
 
filter[fee_currency]
string
 
filter[net_amount_cents]
string
 
filter[net_amount_currency]
string
 
filter[processor_state]
string
 
filter[transfer_credit_type]
string
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/payouts
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create
Creates an new Payout


SecuritybearerAuth 
Request 
query Parameters
fields[payout_methods]
Array of strings
 
 Example:  fields[payout_methods]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


401
Unauthorized


403
Forbidden


406
Not Acceptable


415
Unsupported Media Type


422
Unprocessible Entity


post/payouts
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Payout


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[payout_methods]
Array of strings
 
 Example:  fields[payout_methods]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/payouts/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Customers
A customer in Edge represents a customer in your business. While the customer resource is considered optional, it is highly recommended that you create a customer for each of your customers. This will allow you to track past transactions involving the customer and will be used as evidence in the case of a chargeback/dispute.


List of Customers
Lists all Customers


SecuritybearerAuth 
Request 
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
fields[subscriptions]
Array of strings
 
 Example:  fields[subscriptions]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[addresses]
Array of strings
 
 Example:  fields[addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[description]
string
 
filter[email]
string
 
filter[name]
string
 
filter[phone_number]
string
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/customers
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create
Creates an new Customer


SecuritybearerAuth 
Request 
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
fields[subscriptions]
Array of strings
 
 Example:  fields[subscriptions]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[addresses]
Array of strings
 
 Example:  fields[addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


401
Unauthorized


403
Forbidden


406
Not Acceptable


415
Unsupported Media Type


422
Unprocessible Entity


post/customers
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Customer


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
fields[subscriptions]
Array of strings
 
 Example:  fields[subscriptions]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[addresses]
Array of strings
 
 Example:  fields[addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/customers/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Update
Updates an existing Customer


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[charges]
Array of strings
 
 Example:  fields[charges]=id,created_at,updated_at
fields[payment_methods]
Array of strings
 
 Example:  fields[payment_methods]=id,created_at,updated_at
fields[subscriptions]
Array of strings
 
 Example:  fields[subscriptions]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[addresses]
Array of strings
 
 Example:  fields[addresses]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


406
Not Acceptable


patch/customers/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Consumer Addresses
ConsumerAddress represents a physical address related to a customer, a charge (as a shipping address) or a payment method (as a billing address).


Scoping


ConsumerAddresses are scoped to your current mode (sandbox or live) denoted by the API Key.


List of Consumer Addresses
Lists all Consumer Addresses


SecuritybearerAuth 
Request 
query Parameters
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[city]
string
 
filter[country]
string
 
filter[line_1]
string
 
filter[line_2]
string
 
filter[state]
string
 
filter[zip]
string
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/consumer_addresses
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create
Creates an new Consumer Address


SecuritybearerAuth 
Request 
query Parameters
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


401
Unauthorized


403
Forbidden


406
Not Acceptable


415
Unsupported Media Type


422
Unprocessible Entity


post/consumer_addresses
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Consumer Address


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/consumer_addresses/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Legal Addresses
LegalAddress represents a physical address associated with the merchant account opener and the beneficial owners.


Scoping


Unlike its counterpart ConsumerAddress LegalAddress are not scoped to modes sandbox or live.


List of Legal Addresses
Lists all Legal Addresses


SecuritybearerAuth 
Request 
query Parameters
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[city]
string
 
filter[country]
string
 
filter[line_1]
string
 
filter[line_2]
string
 
filter[state]
string
 
filter[zip]
string
 
Responses 
200
filtered by zip


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/legal_addresses
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create
Creates an new Legal Address


SecuritybearerAuth 
Request 
query Parameters
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


401
Unauthorized


403
Forbidden


406
Not Acceptable


415
Unsupported Media Type


422
Unprocessible Entity


post/legal_addresses
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Legal Address


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/legal_addresses/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Update
Updates an existing Legal Address


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


406
Not Acceptable


patch/legal_addresses/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Attachments
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur varius ullamcorper sapien, id tempor eros efficitur at. Praesent suscipit cursus ipsum, at ultrices dui convallis a. Proin sit amet lectus libero. Etiam eu diam magna. Sed laoreet faucibus aliquet. Nam lobortis risus eget arcu pretium, at euismod justo bibendum. Fusce varius venenatis lectus a molestie. Vivamus lorem purus, egestas a consequat ut, dapibus et eros. Etiam porta ligula nec velit posuere iaculis. In molestie et massa et pulvinar. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.


Integer vel finibus lorem. Mauris nec dui eu quam varius lobortis. Cras tempor justo quis diam ultricies faucibus. Pellentesque tempus vulputate odio, eu sagittis lorem. Fusce sagittis dui in justo aliquet efficitur. Aliquam sed ex sed nulla imperdiet tempor at aliquet nibh. Proin mollis ante ut interdum elementum. Nam dignissim gravida accumsan. Curabitur consectetur pulvinar sem, vel pretium quam convallis sit amet. Ut lorem eros, malesuada id tempor ac, porttitor non quam. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed scelerisque, ipsum a pulvinar scelerisque, turpis tortor interdum mi, vel vestibulum nisl odio nec tellus. Sed eu metus vitae ex aliquet mattis non non orci. Vestibulum malesuada ac mauris in lobortis. Sed dapibus neque quis enim eleifend vehicula. Vivamus imperdiet dignissim velit quis varius.


Morbi lectus lacus, auctor ac justo ut, ornare imperdiet turpis. Pellentesque sit amet arcu sit amet erat varius eleifend sit amet sed augue. Nunc sed nulla at nisi vestibulum tempor in sit amet odio. In elit turpis, pellentesque vel venenatis ac, sodales nec nibh. Cras laoreet tristique dui quis bibendum. Nullam condimentum turpis magna, quis laoreet purus placerat nec. Nulla facilisi. Proin elit justo, euismod et faucibus vel, volutpat id nulla. Quisque blandit ipsum non lorem aliquam pharetra.


Integer pellentesque turpis sit amet ipsum tristique sagittis. Proin diam nulla, cursus non pharetra a, mattis a leo. Mauris eget porta diam. Duis ultrices, turpis a facilisis lacinia, velit neque blandit nibh, et egestas nisl tortor ut est. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla rutrum ipsum enim. Donec hendrerit ipsum risus, ac fermentum magna maximus et. Donec augue felis, gravida sit amet tempus ac, tempus eu nibh. Sed pellentesque blandit arcu eget viverra. Suspendisse augue nibh, aliquam eget lorem at, ullamcorper facilisis mauris. In sit amet sollicitudin tellus, ultricies sollicitudin ipsum. Nulla pellentesque tempor risus. Nam venenatis quis augue quis ultricies. Mauris ligula risus, placerat et placerat at, ultrices suscipit ante.


Curabitur tristique auctor nulla, non pretium lectus feugiat nec. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris faucibus id nulla id elementum. Maecenas ut volutpat mi. Donec bibendum egestas est vel malesuada. Cras ut gravida nibh, eget facilisis odio. Nulla laoreet nulla vel massa vulputate gravida. Aliquam mauris elit, tempor id ex et, pulvinar ultrices enim.


Show
Shows an individual Attachment


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[records]
Array of strings
 
 Example:  fields[records]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/attachments/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Webhook Subscriptions
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur varius ullamcorper sapien, id tempor eros efficitur at. Praesent suscipit cursus ipsum, at ultrices dui convallis a. Proin sit amet lectus libero. Etiam eu diam magna. Sed laoreet faucibus aliquet. Nam lobortis risus eget arcu pretium, at euismod justo bibendum. Fusce varius venenatis lectus a molestie. Vivamus lorem purus, egestas a consequat ut, dapibus et eros. Etiam porta ligula nec velit posuere iaculis. In molestie et massa et pulvinar. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.


Integer vel finibus lorem. Mauris nec dui eu quam varius lobortis. Cras tempor justo quis diam ultricies faucibus. Pellentesque tempus vulputate odio, eu sagittis lorem. Fusce sagittis dui in justo aliquet efficitur. Aliquam sed ex sed nulla imperdiet tempor at aliquet nibh. Proin mollis ante ut interdum elementum. Nam dignissim gravida accumsan. Curabitur consectetur pulvinar sem, vel pretium quam convallis sit amet. Ut lorem eros, malesuada id tempor ac, porttitor non quam. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed scelerisque, ipsum a pulvinar scelerisque, turpis tortor interdum mi, vel vestibulum nisl odio nec tellus. Sed eu metus vitae ex aliquet mattis non non orci. Vestibulum malesuada ac mauris in lobortis. Sed dapibus neque quis enim eleifend vehicula. Vivamus imperdiet dignissim velit quis varius.


Morbi lectus lacus, auctor ac justo ut, ornare imperdiet turpis. Pellentesque sit amet arcu sit amet erat varius eleifend sit amet sed augue. Nunc sed nulla at nisi vestibulum tempor in sit amet odio. In elit turpis, pellentesque vel venenatis ac, sodales nec nibh. Cras laoreet tristique dui quis bibendum. Nullam condimentum turpis magna, quis laoreet purus placerat nec. Nulla facilisi. Proin elit justo, euismod et faucibus vel, volutpat id nulla. Quisque blandit ipsum non lorem aliquam pharetra.


Integer pellentesque turpis sit amet ipsum tristique sagittis. Proin diam nulla, cursus non pharetra a, mattis a leo. Mauris eget porta diam. Duis ultrices, turpis a facilisis lacinia, velit neque blandit nibh, et egestas nisl tortor ut est. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla rutrum ipsum enim. Donec hendrerit ipsum risus, ac fermentum magna maximus et. Donec augue felis, gravida sit amet tempus ac, tempus eu nibh. Sed pellentesque blandit arcu eget viverra. Suspendisse augue nibh, aliquam eget lorem at, ullamcorper facilisis mauris. In sit amet sollicitudin tellus, ultricies sollicitudin ipsum. Nulla pellentesque tempor risus. Nam venenatis quis augue quis ultricies. Mauris ligula risus, placerat et placerat at, ultrices suscipit ante.


Curabitur tristique auctor nulla, non pretium lectus feugiat nec. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris faucibus id nulla id elementum. Maecenas ut volutpat mi. Donec bibendum egestas est vel malesuada. Cras ut gravida nibh, eget facilisis odio. Nulla laoreet nulla vel massa vulputate gravida. Aliquam mauris elit, tempor id ex et, pulvinar ultrices enim.


List of Webhook Subscriptions
Lists all Webhook Subscriptions


SecuritybearerAuth 
Request 
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[active]
string
 
filter[concurrency_limit]
string
 
filter[description]
string
 
filter[url]
string
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/webhook_subscriptions
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create
Creates an new Webhook Subscription


SecuritybearerAuth 
Request 
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


401
Unauthorized


403
Forbidden


406
Not Acceptable


415
Unsupported Media Type


422
Unprocessible Entity


post/webhook_subscriptions
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Webhook Subscription


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/webhook_subscriptions/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Update
Updates an existing Webhook Subscription


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


406
Not Acceptable


patch/webhook_subscriptions/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Destroy
Destroys an existing Webhook Subscription


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[events]
Array of strings
 
 Example:  fields[events]=id,created_at,updated_at
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


406
Not Acceptable


delete/webhook_subscriptions/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}
Events
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur varius ullamcorper sapien, id tempor eros efficitur at. Praesent suscipit cursus ipsum, at ultrices dui convallis a. Proin sit amet lectus libero. Etiam eu diam magna. Sed laoreet faucibus aliquet. Nam lobortis risus eget arcu pretium, at euismod justo bibendum. Fusce varius venenatis lectus a molestie. Vivamus lorem purus, egestas a consequat ut, dapibus et eros. Etiam porta ligula nec velit posuere iaculis. In molestie et massa et pulvinar. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.


Integer vel finibus lorem. Mauris nec dui eu quam varius lobortis. Cras tempor justo quis diam ultricies faucibus. Pellentesque tempus vulputate odio, eu sagittis lorem. Fusce sagittis dui in justo aliquet efficitur. Aliquam sed ex sed nulla imperdiet tempor at aliquet nibh. Proin mollis ante ut interdum elementum. Nam dignissim gravida accumsan. Curabitur consectetur pulvinar sem, vel pretium quam convallis sit amet. Ut lorem eros, malesuada id tempor ac, porttitor non quam. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed scelerisque, ipsum a pulvinar scelerisque, turpis tortor interdum mi, vel vestibulum nisl odio nec tellus. Sed eu metus vitae ex aliquet mattis non non orci. Vestibulum malesuada ac mauris in lobortis. Sed dapibus neque quis enim eleifend vehicula. Vivamus imperdiet dignissim velit quis varius.


Morbi lectus lacus, auctor ac justo ut, ornare imperdiet turpis. Pellentesque sit amet arcu sit amet erat varius eleifend sit amet sed augue. Nunc sed nulla at nisi vestibulum tempor in sit amet odio. In elit turpis, pellentesque vel venenatis ac, sodales nec nibh. Cras laoreet tristique dui quis bibendum. Nullam condimentum turpis magna, quis laoreet purus placerat nec. Nulla facilisi. Proin elit justo, euismod et faucibus vel, volutpat id nulla. Quisque blandit ipsum non lorem aliquam pharetra.


Integer pellentesque turpis sit amet ipsum tristique sagittis. Proin diam nulla, cursus non pharetra a, mattis a leo. Mauris eget porta diam. Duis ultrices, turpis a facilisis lacinia, velit neque blandit nibh, et egestas nisl tortor ut est. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla rutrum ipsum enim. Donec hendrerit ipsum risus, ac fermentum magna maximus et. Donec augue felis, gravida sit amet tempus ac, tempus eu nibh. Sed pellentesque blandit arcu eget viverra. Suspendisse augue nibh, aliquam eget lorem at, ullamcorper facilisis mauris. In sit amet sollicitudin tellus, ultricies sollicitudin ipsum. Nulla pellentesque tempor risus. Nam venenatis quis augue quis ultricies. Mauris ligula risus, placerat et placerat at, ultrices suscipit ante.


Curabitur tristique auctor nulla, non pretium lectus feugiat nec. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris faucibus id nulla id elementum. Maecenas ut volutpat mi. Donec bibendum egestas est vel malesuada. Cras ut gravida nibh, eget facilisis odio. Nulla laoreet nulla vel massa vulputate gravida. Aliquam mauris elit, tempor id ex et, pulvinar ultrices enim.


List of Events
Lists all Events


SecuritybearerAuth 
Request 
query Parameters
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[resources]
Array of strings
 
 Example:  fields[resources]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
filter[code]
string
 
Responses 
200
OK


401
Unauthorized


403
Forbidden


406
Not Acceptable


get/events
Request samples 
Response samples 
application/vnd.api+json
{
  • "links": {},
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Show
Shows an individual Event


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
A UUID that identifies an object


 
 Example:  32e46c03-a4e1-53e7-93e4-936fad0196a1
query Parameters
fields[merchant_accounts]
Array of strings
 
 Example:  fields[merchant_accounts]=id,created_at,updated_at
fields[resources]
Array of strings
 
 Example:  fields[resources]=id,created_at,updated_at
include
Array of strings
 
 Example:  include=a,a.b,c,c.d.e
Responses 
200
OK


401
Unauthorized


404
Not Found


406
Not Acceptable


get/events/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "meta": {
    }
}