{"info":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"19035881","collectionId":"4e8b757f-1146-45ee-a531-5025f130f16c","publishedId":"2s93zCa1nF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"336699"},"publishDate":"2023-07-14T15:51:13.000Z"},"item":[{"name":"Overview","item":[{"name":"Introduction","item":[],"id":"fa798bfc-607e-45f5-9ac8-caa517359c70","description":"

The BridgePay Recurring Billing API is a RESTful API providing an Internet-facing web services interface for the creation and management of Recurring Billing Accounts and Contracts.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"24667e13-7bf9-4506-8050-2c09806715a2"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b013b649-6062-4176-a6dd-28825ce51274"}}],"_postman_id":"fa798bfc-607e-45f5-9ac8-caa517359c70"},{"name":"Connection Strings","item":[],"id":"0f9ed3bc-e41f-4017-ada6-30b232f329f8","description":"

The following URLs are the base URLs used for the Recurring Billing API:

TEST
http://www.bridgepaynetsecuretest.com/Recurringbilling.Api/api/

PROD
http://www.bridgepaynetsecuretx.com/Recurringbilling.Api/api/

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a56a5c8f-7d7e-422a-a171-5bf73e188f14"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"70192912-27b5-40ae-a97a-7c155f260df1"}}],"_postman_id":"0f9ed3bc-e41f-4017-ada6-30b232f329f8"},{"name":"Key Elements","item":[],"id":"49e6ba9f-531d-4fe3-a8c3-79220ca06686","description":"

The Recurring Billing API requires a series of hierarchical objects which will be used to construct a recurring billing contract. Users are encouraged to work through the order laid out in the process flow section to create each necessary object.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"34814ba2-c185-4cf5-8b55-a55ad3e10322"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4cbe795b-d241-4adf-80f4-3227869ea173"}}],"_postman_id":"49e6ba9f-531d-4fe3-a8c3-79220ca06686"},{"name":"Process Flow","item":[],"id":"ecd960ab-3d31-41dc-ad5a-d15e26f42d24","description":"

There is a process flow the must be followed from the creation of an account, to the creation and scheduling of a contract; however, note that step 4 must be completed using the WalletAPI's CreateWalletView method. The process is listed as follows:

Create Account (Generates AccountID)
Create Address (Generates AddresID)
Create Contact (Generates ContactID)
Create Wallet with Payment Method via WalletAPI (Generates WalletID)
Create Account Holder (Generates AccountHolderID)
Create Product (Generates ProductID)
CreateBilling Frequency (Generates FrequencyID)
CreateContract (Generates ContractID)

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d8bebdbc-1785-4e44-a0af-c96910104354"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"47e9c77c-c259-4a61-93e8-079d8bc9af59"}}],"_postman_id":"ecd960ab-3d31-41dc-ad5a-d15e26f42d24"},{"name":"Authentication Information","item":[],"id":"553a5d10-7d57-4673-a046-748cad0c6db5","description":"

All end points are authenticated by basic authentication, which must be provided in the authorization header using Authorization: Basic, along with the 64bit encoded credential string using iso-8859-1 encoding. Credentials are formed by the username/password combination. In addition, all traffic must be submitted over the https transport protocol; non-http traffic will be forwarded to the appropriate https endpoint.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"05958795-6c4d-4fa2-a67d-cada3ef7d868"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ab814b64-712f-49b6-9e8c-e1904f7b70d4"}}],"_postman_id":"553a5d10-7d57-4673-a046-748cad0c6db5"},{"name":"Sample Request & Response","item":[],"id":"b1e80fee-2191-47ca-8a9c-9f62bedc2fad","description":"

Rather than provide a sample request and response layout, because they are different for each request, this section will provide information on the three methods supported by the API.

GET

Unless otherwise specified, all get collection commands return an EntityList object where T is the EntityModel for that particular endpoints (for example EntityList for the api/accounts/).The EntityModel is composed of the Results objects which contains an IEnumerable of the returned entities, the Links objects which contains the self-describing links, as well as the TotalCount, TotalPages, and Page objects which contain information about the total entities, total pages, and current page respectively. Each collection endpoint accepts the following arguments in addition to any specific entity arguments:

IncludeGraph: specifies whether to return the whole graph, the default is false if not specified
Page: specifies which page of results to return, 0 is the default.
Page_Size: specifies the number of records to return per page, 25 is the default.
SearchFalse: specifies on whether to take into account false values when filtering, false isthe default.

The collection endpoints can filter on any property for the entity which the end point represents. For example, the api/accounts endpoint could accept any or all of Name, AccountNumber, or IsActive query string arguments along with the default arguments. To return a single record, specify the ID as specified by the route api/{controller}/{id} (for example api/accounts/1) and optional specify the query string argument IncludeGraph=true (default is false) to return the whole graph of an object (i.e. child elements and collections).

POST

Posts use the same endpoints as a collection get, and you must specify every required field for an endpoint to successfully post an entity. You can also post a graph including non-collection child elements as specified below. Do not post the ID of the item either in the URL or the body of the post, as the Id is automatically assigned when the item is added to the database. The return of this will contain a result with the newly posted entity including the generated Id identifier.

PUT/PATCH

Put is similar to post, except that it is used to update already existing items and the ID should be specified both in the body and the URL. Using Put, you must specify every field for each entity you are updating, so if you updating a graph with one child element off the parent you must specify every field for both parent and child. If you are not updating a child element just leave it as null. Patch like Put, is used for updating and you must specify the Id in both the query string and the body, however with Patch you only need to specify the fields you updating. This is true on graphs as well, so that you could specify just one field and a child element and update both the Parent and the Child entity on one call.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"6bc04db4-3e1a-4366-a1ea-76bc23c55f32"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a0c91623-3547-4db4-80a0-043ae6863db8"}}],"_postman_id":"b1e80fee-2191-47ca-8a9c-9f62bedc2fad"}],"id":"a5d6b064-393a-44b4-a862-533d17019287","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"a8cc22bc-8d6f-461f-a0cd-4489cbfa7d1c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"168b9581-354d-449a-a9f6-50734d95b063"}}],"_postman_id":"a5d6b064-393a-44b4-a862-533d17019287","description":""},{"name":"Integration Support","item":[],"id":"4d45ed55-dc82-4448-a31f-fa291332eae9","description":"

A test or live merchant account with BridgePay is necessary to successfully process transactions. To acquire a test account, complete the test account request form located on the BridgePay Integrator Support Portal.

To review additional documentation, please visit the Developer Center. For Integrations Assistance, please Enter a Case.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2ac42416-02bc-41dd-af8a-b052eb1459ff"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5712b78b-4300-42e7-a2de-7ca8b7c49fb3"}}],"_postman_id":"4d45ed55-dc82-4448-a31f-fa291332eae9"},{"name":"Request & Response Information","item":[],"id":"a02b259e-4625-4ee5-9882-260c8867744a","description":"

Because each request will contain largely different content, the request and response information will be defined in each specific request layout.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"67fb956f-712a-4862-8e06-cc9dc18d7014"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"4437a2ce-e602-4cca-adf6-743780e48798"}}],"_postman_id":"a02b259e-4625-4ee5-9882-260c8867744a"},{"name":"Specific Request Layouts","item":[{"name":"Accounts","item":[{"name":"Account","id":"de372b1c-90f3-496d-87e7-1fcd2636faf1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/accounts/{accountID}","description":"

GET: api/accounts/{id}

This returns a single Account entity specified by the Id attribute on the end of the URL. Optionally, IncludeGraph=true can be added to the query string to return the Contracts and AccountHolders child collections.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetAccount
Purpose:	Returns the Entity for a given unique id wrapped in an IHttpActionResult.
Access:	{URL} /RecurringBilling.Api/api/Accounts/5
Method:	GET: api/Accounts/GetAccount
Required Parameters:	Id - Unique id for the requested Entity. IncludeGraph - True/False whether to return the child entities of the entities requested.

GET: api/accounts/
This returns an EntityList accepts the following query string arguments in addition to the default arguments above: AccountNumber, Name, IsActive (true/false).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetAccounts
Purpose:	Returns a list of an EntityList object which includes values for TotalCount, TotalPages, Page, Links, and Results , which contains a collection of the Entity.
Access:	{URL} /RecurringBilling.Api/api/Accounts
Method:	GET: api/Accounts
Required Parameters:	IncludeGraph -True/False whether to return the child entities of the entities requested. Page - The page or results to return. Page_Size - The size of the page of results to return, the default being 25. SearchFalse - True/False whether to search false values for boolean argum ents in the querystring. Entity - Any of the fields in this object can be used as query string filters: MerchantId, AccountName, AccountNumber, CreatedOn, ModifiedOn, and IsActive.

POST: api/accounts/
This endpoint accepts an Account entity, with no child elements. Only the MerchantId is required, however it is recommended to give the Account a name as well. Figure 3 shows an example Post body for an Account entity.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PostAccount
Purpose:	Adds an entity to the database from the model provided. On success, returns the updated entity wrapped in an IHttpActionResult, with the Id value of the entity set.
Access:	{URL}
Method:	POST: api/Accounts
Required Parameters:	Account - The entity model to be inserted

PATCH: api/accounts/{id} Specify the Id in the URL and any fields you want to update with PATCH.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PatchAccount
Purpose:	Updates an entity based on the specified fields. This method works for Http method PATCH.
Access:	{URL}
Method:	[HttpPatch]
Required Parameters:	Id - Unique id for the requested Entity. Account - The entity model to be updated.

The Account entity is used to store the Customer Name and Account Number of the customer to be added. This will be linked to entities created later in the process.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Property Name	Length	Data Type	Description
O	Name	0-50	nvarchar	Name of the account.
O	AccountNumber	0-25	nvarchar	Account number as a string for the account.
R	IsActive	1	boolean	Default is 'false' (0) if not specified in Post.
R	MerchantID		integer	The MerchantAccountCode for the gateway on which the Account will be created. Only relevant on POST and GET. MerchantID cannot be updated.

","_postman_id":"d89c7569-5929-4cca-9921-a226abfa5d59","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}},{"name":"Addresses","item":[{"name":"Address","id":"a79cac8f-2c39-4bb0-97d8-63aeae5236a8","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"X-RB-MerchantId","type":"text","value":"{merchantAccountCode}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/addresses/{addressID}","description":"

GET: api/addresses/{id}
This returns a single Address entity specified by the Id attribute on the end of the URL. There are no optional arguments of this endpoint.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetAddress
Purpose:	Returns the Entity for a given unique id wrapped in an IHttpActionResult.
Access:	{URL}
Method:	GET: api/Addresses/GetAddress
Required Parameters:	Id - Unique id for the requested entity

GET: api/addresses/
This returns an EntityList accepts any of the above fields as optional arguments to filter the return results.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetAddresses
Purpose:	Returns the requested entities wrapped in an EntityList object which includes values for TotalCount, TotalPages, Page, Links, and Results, which contains a collection of the Entity.
Access:	{URL}
Method:	GET: api/Addresses/GetAddresses
Required Parameters:	Page - The page or results to return Page - The size of the page of results to return, the default being 25. Entity - The Entity whose child properties can be used as filter values in the query string: AddressStreet, AddressStreetTwo, AddressCity, AddressState, AddressCountry, and AddressZip.

POST: api/addresses/

This endpoint accepts an Address entity, with no child elements. There are no required fields, but all fields must be specified even if they contain empty strings or null values.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PostAddress
Purpose:	Adds an entity to the database from the model provided. On success, returns the updated entity wrapped in an IHttpActionResult, with the Id value ofthe entity set.
Access:	{URL}
Method:	POST: api/Addresses/PostAddress
Required Parameters:	Address - The entity model to be inserted

PATCH: api/contacts/{id}

Specify the Id in the URL and any fields you want to update with PATCH.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PatchAddress
Purpose:	Updates an entity based on the specified fields. This method works for Http method PATCH.
Access:	{URL}
Method:	[HttpPatch]
Requried Parameters:	Id - Unique id for the entity to be updated Address - The entity model to be updated

The Address entity is used to store address information that can be attached to a customer record.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Property Name	Length	Data Type	Description
O	AddressStreet	0-25	nvarchar	Street address
O	AddressStreetTwo	0-25	nvarchar	Street address continued
O	AddressCity	0-30	nvarchar	City
O	AddressState	0-30	nvarchar	State
O	AddressCountry	0-30	nvarchar	Country
O	AddressZip	0-10	nvarchar	Zip code

","_postman_id":"52fa7f8f-6d57-4404-873c-195e98e7d105","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}},{"name":"Contacts","item":[{"name":"Contact","id":"29917eb3-65ad-4fd0-a403-b9bf747032b4","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"}],"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/contacts/{contactID}","description":"

GET: api/contacts/{id}

This returns asingle Contact entity specified by the Id attribute on the end of the URL. Optionally, IncludeGraph=true can be added to the query string to return ContactAddress as well.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetContact
Purpose:	Returns the Entity for a given unique id wrapped in an IHttpActionResult.
Access:	{URL}
Method:	GET: api/Contacts/GetContact
Required Parameters:	Id - Unique id for the requested Entity IncludeGraph - True/False whether to return the child entities of the Entity requested.

GET: api/contacts/
This returns an EntityList accepts any of the above arguments in addition to the defaultarguments.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetContacts
Purpose:	Returns the requested entities wrapped in a n EntityList object which includes values for TotalCount, TotalPages, Page, Links, and Results , whi ch contains a collection of the Entity.
Access:	{URL}
Method:	GET: api/Contacts/GetContacts
Required Parameters:	IncludeGraph - True/False whether to return the child entities of the Entity requested. Page - The page or results to return Page_Size - The size of the page of results to return, the default being 25. SearchFalse - True/False whether to search false values for boolean arguments in the querystring. Entity - The Entity whose child properties can be used as filter values in the query string: ContactTypeId, ContactFirstName, ContactLastName, CompanyName, AddressId, ContactDepartment, ContactTitle, ContactEmail, ContactDayPhone, ContactEveningPhone, ContactMobilePhone, ContactFax, and IsActive.

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["RecurringBilling.API","api","contacts"],"host":["www.bridgepaynetsecuretest.com"],"query":[{"disabled":true,"key":"AddressId","value":"12317"}],"variable":[]}},"response":[{"id":"58a084c6-be3d-4342-b002-114c9fc08724","name":"Contacts","originalRequest":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"},{"key":"X-RB-OrganizationId","value":"","type":"text","disabled":true}],"url":{"raw":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/contacts","protocol":"https","host":["www.bridgepaynetsecuretest.com"],"path":["RecurringBilling.API","api","contacts"],"query":[{"key":"AddressId","value":"12317","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Page\": 0,\r\n \"TotalPages\": 1,\r\n \"TotalCount\": 3,\r\n \"Results\": [\r\n {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts/30360\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts\",\r\n \"Rel\": \"newContact\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 30360,\r\n \"ContactTypeId\": 1,\r\n \"ContactFirstName\": \"Noah\",\r\n \"ContactLastName\": \"Hippensteel\",\r\n \"CompanyName\": null,\r\n \"AddressId\": 29120,\r\n \"ContactDepartment\": null,\r\n \"ContactTitle\": null,\r\n \"ContactEmail\": \"noah.hippensteel@bridgepaynetwork.com\",\r\n \"ContactDayPhone\": \"5555555555\",\r\n \"ContactEveningPhone\": null,\r\n \"ContactMobilePhone\": null,\r\n \"ContactFax\": null,\r\n \"IsActive\": false,\r\n \"ContactAddress\": null\r\n },\r\n {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts/36823\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts\",\r\n \"Rel\": \"newContact\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 36823,\r\n \"ContactTypeId\": 1,\r\n \"ContactFirstName\": \"FName\",\r\n \"ContactLastName\": \"LName\",\r\n \"CompanyName\": null,\r\n \"AddressId\": 35420,\r\n \"ContactDepartment\": null,\r\n \"ContactTitle\": null,\r\n \"ContactEmail\": \"email@email.com\",\r\n \"ContactDayPhone\": \"9875665498\",\r\n \"ContactEveningPhone\": null,\r\n \"ContactMobilePhone\": null,\r\n \"ContactFax\": null,\r\n \"IsActive\": true,\r\n \"ContactAddress\": null\r\n },\r\n {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts/36823\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts\",\r\n \"Rel\": \"newContact\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 36823,\r\n \"ContactTypeId\": 1,\r\n \"ContactFirstName\": \"FName\",\r\n \"ContactLastName\": \"LName\",\r\n \"CompanyName\": null,\r\n \"AddressId\": 35420,\r\n \"ContactDepartment\": null,\r\n \"ContactTitle\": null,\r\n \"ContactEmail\": \"email@email.com\",\r\n \"ContactDayPhone\": \"9875665498\",\r\n \"ContactEveningPhone\": null,\r\n \"ContactMobilePhone\": null,\r\n \"ContactFax\": null,\r\n \"IsActive\": true,\r\n \"ContactAddress\": null\r\n }\r\n ],\r\n \"Links\": [],\r\n \"Exception\": null\r\n}"}],"_postman_id":"f6eff628-6882-4eed-bf7e-e5feb5aacc25"},{"name":"Create Contact","id":"ec2d9692-2c60-4a8b-81d4-48f517bc1129","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"ContactTypeId\": 1,\r\n\t\"AddressId\": 35420,\r\n\t\"ContactFirstName\": \"FName\",\r\n\t\"ContactLastName\": \"LName\",\r\n\t\"CompanyName\": null,\r\n\t\"ContactDepartment\": null,\r\n\t\"ContactTitle\": null,\r\n\t\"ContactEmail\": \"email@email.com\",\r\n\t\"ContactDayPhone\": \"9875665498\",\r\n\t\"ContactEveningPhone\": null,\r\n\t\"ContactMobilePhone\": null,\r\n\t\"ContactFax\": null,\r\n\t\"IsActive\": true,\r\n\t\"ContactAddress\": null\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/contacts","description":"

POST: api/contacts/

This endpoint accepts a Contact entity, with an optional ContactAddress child. Remember to specify theAddressId or the ContactAddress but not both. Figure 5, has an example of a Contact with a childContactAddress

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PostContact
Purpose:	Adds an entity to the database from the model provided. On success, returns the updated entity wrapped in an IHttpActionResult, with the I d value of the entity set.
Access:	{URL}
Method:	POST: api/Contacts/PostContacts
Required Parameters:	Contact - The entity model to be inserted

PATCH: api/contacts/{id}

Specify the Id in the URL and any fields you want to update with Patch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PatchContact
Purpose:	Updates an entity based on the specified fields.
Access:	{URL}
Method:	[HttpPatch]
Required Parameters:	Id - Unique id for the entity to be updated. Model - The entity model to be updated.

Note: Contacts can either have a ContactTypeId of 1 for Merchant or 2 for Customer. The Contact thatis a child of the AccountHolder entity is of type Customer (id 2).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Property Name	Length	Data Type	Description
R	ContactTypeID		integer	Specify 1 (Merchant) or 2 (Customer)
C	AddressID		integer	The ID of the corresponding Address. Required if not specifying a child Address in POST.
O	ContactFirstName	0-30	nvarchar	Contact first name. Optional, but recommended.
O	ContactLastName	0-30	nvarchar	Contact first name. Optional, but recommended.
O	CompanyName	0-35	nvarchar	Company name
O	ContactDepartment	0-20	nvarchar	Contact department
O	ContactTitle	0-20	nvarchar	Title of the contact (Doctor, Sir, Madam, Mr, Professor, etc).
O	ContactEmail	5-50	nvarchar	The email of the contact. Used for automated emails and receipts. Must meet the X@y.z format. Optional, but recommended.
O	ContactDayPhone	0-20	nvarchar	Daytime contact number
O	ContactEveningPhone	0-20	nvarchar	Evening contact number
O	ContactMobilePhone	0-20	nvarchar	Mobile contact number
O	ContactFax	0-20	nvarchar	Fax number for contact
O	IsActive		boolean	Since the default is false for all Boolean variables, this must be specified as True when posting 'new' Contacts.
C	ContactAddress		nvarchar	Address entity. Either this or the AddressId must be specified for POST, but not both. See the 'Addresses' endpoing for more details on the AddressModel fields.

","_postman_id":"24b91e83-35e0-4e4a-b21e-e16a8d3501f4","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}},{"name":"AccountHolders","item":[{"name":"AccountHolder","id":"9960f3f8-7bc3-4688-88e2-a01840f4ab5a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/accounts/9165/accountholders/{accountHolderID}","description":"

GET: api/accounts/{accountId}/accountholders/{id}
This returns a single AccountHolder entity specified by the Id attribute on the end of the URL. There is no need to use the IncludeGraph=true argument as the child entities for Customer and CustomerAddress are always returned with the AccountHolder, as well as the parent Account.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetAccountHolder
Purpose:	Returns the Entity for a given unique id wrapped in an IHttpActionResult.
Access:	{URL}
Method:	GET: api/Accounts/GetAccountHolder
Required Parameters:	AccountId - Unique id for the parent Account. Id - Unique id for the requested Entity. includeGraph - True/False whether to return the child entities of the Entity requested.

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["RecurringBilling.API","api","accounts","9165","accountholders","{accountHolderID}"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"f40af0c0-3849-4473-a582-0bc1fe7de8e4","name":"AccountHolder","originalRequest":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"},{"key":"X-RB-OrganizationId","value":"","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/accounts/9165/accountholders/{accountHolderID}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/accounts/37690/accountholders/36878\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/accounts/37690/accountholders/36878\",\r\n \"Rel\": \"Post\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 36878,\r\n \"AccountId\": 37690,\r\n \"ContactId\": 36823,\r\n \"MerchantId\": 13026001,\r\n \"Order\": 1,\r\n \"IsActive\": true,\r\n \"Guid\": \"1ea1ab62-8010-47e4-b0e8-cd58f714a7d3\",\r\n \"Customer\": {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts/36823\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts/36878\",\r\n \"Rel\": \"newContact\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 36823,\r\n \"ContactTypeId\": 1,\r\n \"ContactFirstName\": \"FName\",\r\n \"ContactLastName\": \"LName\",\r\n \"CompanyName\": null,\r\n \"AddressId\": 35420,\r\n \"ContactDepartment\": null,\r\n \"ContactTitle\": null,\r\n \"ContactEmail\": \"email@email.com\",\r\n \"ContactDayPhone\": \"9875665498\",\r\n \"ContactEveningPhone\": null,\r\n \"ContactMobilePhone\": null,\r\n \"ContactFax\": null,\r\n \"IsActive\": true,\r\n \"ContactAddress\": {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/addresses/35420\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/addresses/36878\",\r\n \"Rel\": \"newAddress\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 35420,\r\n \"AddressStreet\": \"123 Test Street\",\r\n \"AddressStreetTwo\": null,\r\n \"AddressCity\": \"Lake Smith\",\r\n \"AddressState\": \"FL\",\r\n \"AddressCountry\": \"USA\",\r\n \"AddressZip\": \"33232\",\r\n \"Contacts\": null\r\n }\r\n },\r\n \"Account\": null,\r\n \"Wallet\": null,\r\n \"Contact\": null\r\n}"}],"_postman_id":"9960f3f8-7bc3-4688-88e2-a01840f4ab5a"},{"name":"AccountHolders","id":"c1adf446-5ce5-4397-b58c-5d2eb7a6f9f2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/accounts/9165/accountholders/{accountHolderID}","description":"

GET: api/accounts/{accountId}/accountholders/

This returns an EntityList accepts the following query string arguments in addition tothe default arguments above: AccountId, ContactId, Order, IsActive, Guid.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetAccountHolders
Purpose:	Returns the requested entities wrapped in a n EntityList object which includes values for TotalCount, TotalPages, Page, Links, and Results , which contains a collection of the Entity.
Access:	{URL}
Method:	GET: api/Accounts/
Required Parameters:	AccountId - Unique id for the parent Account. Page - The page or results to return. Page_Size - The size of the page of results to return, the default being 25. includeGraph - True/False whether to return the child entities of the Entity requested. SearchFalse - True/False whether to search false values for boolean arguments in the query string. Entity - The entity whose child properites can be used as filter values in the query string: AccountId, ContactId, MerchantId, Order, Guid, and IsActive.

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["RecurringBilling.API","api","accounts","9165","accountholders","{accountHolderID}"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"c9e8c1cb-0b40-425f-8997-02b02c111ebd","name":"AccountHolders","originalRequest":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"},{"key":"X-RB-OrganizationId","value":"","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/accounts/9165/accountholders/{accountHolderID}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/accounts/37690/accountholders/36878\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/accounts/37690/accountholders/36878\",\r\n \"Rel\": \"Post\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 36878,\r\n \"AccountId\": 37690,\r\n \"ContactId\": 36823,\r\n \"MerchantId\": 13026001,\r\n \"Order\": 1,\r\n \"IsActive\": true,\r\n \"Guid\": \"1ea1ab62-8010-47e4-b0e8-cd58f714a7d3\",\r\n \"Customer\": {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts/36823\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contacts/36878\",\r\n \"Rel\": \"newContact\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 36823,\r\n \"ContactTypeId\": 1,\r\n \"ContactFirstName\": \"FName\",\r\n \"ContactLastName\": \"LName\",\r\n \"CompanyName\": null,\r\n \"AddressId\": 35420,\r\n \"ContactDepartment\": null,\r\n \"ContactTitle\": null,\r\n \"ContactEmail\": \"email@email.com\",\r\n \"ContactDayPhone\": \"9875665498\",\r\n \"ContactEveningPhone\": null,\r\n \"ContactMobilePhone\": null,\r\n \"ContactFax\": null,\r\n \"IsActive\": true,\r\n \"ContactAddress\": {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/addresses/35420\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/addresses/36878\",\r\n \"Rel\": \"newAddress\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 35420,\r\n \"AddressStreet\": \"123 Test Street\",\r\n \"AddressStreetTwo\": null,\r\n \"AddressCity\": \"Lake Smith\",\r\n \"AddressState\": \"FL\",\r\n \"AddressCountry\": \"USA\",\r\n \"AddressZip\": \"33232\",\r\n \"Contacts\": null\r\n }\r\n },\r\n \"Account\": null,\r\n \"Wallet\": null,\r\n \"Contact\": null\r\n}"}],"_postman_id":"c1adf446-5ce5-4397-b58c-5d2eb7a6f9f2"},{"name":"Create AccountHolders","id":"32442b4b-6fb4-4d47-816a-efe13a5f1990","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"AccountID\": 37992,\r\n\t\"ContactID\": 36823,\r\n \"IsActive\": true,\r\n\t\"MerchantID\": {merchantAccountCode},\r\n \"GUID\": \"1ea1ab62-8010-47e4-b0e8-cd58f714a7d3\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/accounts/","description":"

POST: api/accounts/{accountId}/accountholders/
This endpoint accepts an AccountHolder entity, with optional child entities of Customer and Address off the Customer entity. Make sure to use the ContactTypeId of 2 to specify the contact is a CustomerType. An example can be seen below in Figure 3 (note the AddressId and ContactId are both omitted because new objects are being added for both of those child entities).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetAccountHolders
Purpose:	Adds an entity to the datab ase from the model provided. On success, returns the updated entity wrapped in an IHttpActionResult, with the Id value of the entity set.
Access:	{URL}
Method:	POST: api/Accounts/PostAccountHolder
Required Parameters:	AccountHolder - The entity model to be inserted.

PATCH: api/accounts/{accountId}/accountholders/{id}
Specify the Id in the URL and any fields you want to update.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PatchAccountHolder
Purpose:	Updates an entity based on the specified fields.
Access:	{URL}
Method:	[HttpPatch]
Required Parameters:	AccountId - Unique id for the parent Account. Id- Unique id for the entity to be updated. AccountHolder - The entity model to be updated.

Note: Contacts can either have a ContactTypeId of 1 for Merchant or 2 for Customer. The Contact thatis a child of the AccountHolder entity is of type Customer (id 2).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Property Name	Data Type	Description
R	AccountId	integer	Must match the {accountId} in the URL
R	ContactId	integer	Required, except in POST when adding in a new Contact.
O	Order	integer	Order of importance for the AccountHolders; will affect the order of processing of any recurring transactions. The AccountHolder with the lowest Order is considered the primary AccountHolder. If the order is not speci fied for any AccountHolder of an Account, they will be processed in the order in which they were added.
O	IsActive	boolean	Default is false if not specified in POST.
R	MerchantId	integer	Only relevant on POST and GET; you cannot update a MerchantId.
C	Guid	guid	This field is used in conjunction with a wallet API. It should only be used in conjunction with that system and not modified for any other reason, as it will cause the AccountHolder’s wallet to be disassociated with the AccountHolder (in which case no payments will be processed).

","_postman_id":"c8752c09-0950-436c-a3ec-e9c0d17cd3be","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}},{"name":"Products","item":[{"name":"Product","id":"af61f66d-6dee-4258-93b3-8852f7c64fb7","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"X-RB-MerchantId","type":"text","value":"{merchantAccountCode}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/products/{productID}","description":"

GET: api/products/{id}
This returns a single Product entity specified by the Id attribute on the end of the URL. Optionally, IncludeGraph=true can be added to the query string to return Contact as well.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetProduct
Purpose:	Returns the Entity for a given unique id wrapped in a n IHttpActionResult.
Access:	{URL}
Method:	GET: api/Products/{{productId}
Required Parameters:	Id - Unique id for the requested Entity. includeGraph - True/False whether to return the child entities of the Entity requested.

GET: api/products/
This returns an EntityList accepts any of the above arguments in addition to the default arguments.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetProducts
Purpose:	Returns the requested entities wrapped in an EntityList object which includes values for TotalCount, TotalPages, Page, Links, and Results, which contains a collection of the Entity.
Access:	{URL}
Method:	GET: api/Products
Required Parameters:	IncludeGraph - True/False whether to return the child entities of the entities requested. Page - The page or results to return. Page_Size - The size of the page of results to return, the default being 25. SearchFalse - True/False whether to search false values for boolean arguments in the query string. Entity - The Entity whose child properties can be used a filter values in the query string: ProductName, ProductDefaultAmount, Description, ContactId, MerchantId, and IsActive.

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["RecurringBilling.API","api","products"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"75e1a964-79b1-467f-ac31-9c1fb87d0259","name":"Products","originalRequest":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"},{"key":"X-RB-OrganizationId","value":"","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/products"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Page\": 0,\r\n \"TotalPages\": 1,\r\n \"TotalCount\": 3,\r\n \"Results\": [\r\n {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/products/15232\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/products\",\r\n \"Rel\": \"newProduct\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 15232,\r\n \"Name\": \"a;ksdjf;aksdjf\",\r\n \"DefaultAmount\": 1000,\r\n \"Description\": null,\r\n \"ContactId\": 30360,\r\n \"MerchantId\": 13026001,\r\n \"IsActive\": true,\r\n \"Contracts\": [],\r\n \"Contact\": null\r\n },\r\n {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/products/15276\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/products\",\r\n \"Rel\": \"newProduct\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 15276,\r\n \"Name\": \"ProductTest001\",\r\n \"DefaultAmount\": 500000,\r\n \"Description\": \"ProductTesting\",\r\n \"ContactId\": 36823,\r\n \"MerchantId\": 13026001,\r\n \"IsActive\": true,\r\n \"Contracts\": [],\r\n \"Contact\": null\r\n },\r\n {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/products/15278\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/products\",\r\n \"Rel\": \"newProduct\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 15278,\r\n \"Name\": \"ProductTest001\",\r\n \"DefaultAmount\": 500000,\r\n \"Description\": \"ProductTesting\",\r\n \"ContactId\": 36823,\r\n \"MerchantId\": 13026001,\r\n \"IsActive\": true,\r\n \"Contracts\": [],\r\n \"Contact\": null\r\n }\r\n ],\r\n \"Links\": [],\r\n \"Exception\": null\r\n}"}],"_postman_id":"04f1d8f0-d32d-4fab-bb08-f8d848c035ae"},{"name":"Create Product","id":"d58509ac-f67c-413b-9cf0-a1824c353529","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-RB-MerchantId","type":"text","value":"{merchantAccountCode}"}],"body":{"mode":"raw","raw":"{\r\n\t\"Name\": \"ProductTest001\",\r\n\t\"DefaultAmount\": 500000,\r\n\t\"Description\": \"ProductTesting\",\r\n\t\"ContactId\": 36823,\r\n\t\"MerchantId\": {merchantAccountCode},\r\n\t\"IsActive\": true\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/products","description":"

POST: api/products/
This endpoint accepts a Product entity, with an optional Contact child. Remember to specify the ContactId or the Contact but not both. Figure 8, has an example of a Product with a child Contact (which has a child ContactAddress).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PostProduct
Purpose:	Adds an entity to the datab ase from the model provided. On success, returns the updated entity wrapped in an IHttpActionResult, with the Id value of the entity set.
Access:	{URL}
Method:	POST: api/Products
Required Parameters:	Product - The entity model to be inserted.

PATCH: api/products/{id}
Specify the Id in the URL and any fields you want to update with Patch and all of the fields with Put.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PatchProduct
Purpose:	Updates an entity based on the specified fields.
Access:	{URL}
Method:	[HttpPatch]
Required Parameters:	Id - Unique id for the entity to be updated. Model - The entity model to be updated.

Products are templates for which a contract can be built upon.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Property Name	Length	Data Type	Description
R	Name	0-50	nvarchar	Specifies the name of the product.
O	DefaultAmount		integer	Specifies the default BillAmount for a particular product. Used in determining the Contact BillAmount.
O	Description	0-100	nvarchar	Description of the product.
O	ContactId		nvarchar	Optional, but required if the merchant wants email notifications for any Contracts for a specific product.
R	MerchantId		integer	Only relevant on POST and GET; you cannot update a MerchantId.
O	IsActive		boolean	Optional: Since the default is false for all Boolean variables, it should be specified as true when posting 'new' Products.

","_postman_id":"61a31def-7e42-499d-b6c4-e6720775761f","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}},{"name":"Frequencies","item":[{"name":"Frequency","id":"cc30ea89-2daa-4324-8bc6-80b221c3837e","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"X-RB-MerchantId","type":"text","value":"{merchantAccountCode}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/frequencies/{frequencyID}","description":"

GET: api/frequencies/{id}
This returns a single Frequency entity specified by the Id attribute on the end of the URL.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetFrequency
Purpose:	Returns the Entity for a given unique id wrapped in an IHttpActionResult.
Access:	{URL}
Method:	GET: api/Frequencies/{{frequencyId}}
Required Parameters:	Id - Unique id for the requested Entity IncludeGraph - True/False whether to return the child entities of the Entity requested.

GET: api/frequencies
This returns an EntityList and accepts any of the above arguments in addition to th default arguments.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetFrequencies
Purpose:	Returns the requested entities wrapped in an EntityList object which includes values for TotalCound, TotalPages, Page, Links, and Results which contains a collection of the Entity.
Access:	{URL}
Method:	GET: api/Frequencies
Required Parameters:	IncludeGraph - True/False whether to return the child entities of the Entity requested. Page - The page or results to return Page_Size - The size of the page of results to return, the default being 25.

POST: api/frequencies/
This endpoint accepts a Frequency entity, remember to check the fields to the IntervalId to make sure all the required fields are entered for a proper frequency. Figure 7 shows a frequency post.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PostFrequency
Purpose:	Adds an entity to the database from the model provided. On s uccess, returns the updated entity wrapped in an IHttpActionResult, with the Id value of the entity set.
Access:	{URL}
Method:	POST: api/Frequencies
Required Parameters:	Model - The entity model to be inserted.

PATCH: api/frequencies/{id}
Specify the Id in the URL and any fields you want to update with Patch and all of the fields with Put

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PatchFrequency
Purpose:	Updates an entity based on the specified fields.
Access:	{URL}
Method:	[HttpPatch]
Required Parameters:	Id - Unique id for the entity to be updated. Model - The entity moel to be updated.

Not all the Frequency fields are used for a given type. See Interval field description to determinewhich fields to set for a given Interval type.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Required	Property Name	Length	Data Type	Description
O	Name	0-30	nvarchar	Name of the Frequency.
O	Description	0-65	nvarchar	Description of the Frequency
R	MerchantId		integer	Required in POST, ignored in PATCH.
O	NoEnd		boolean	Specified whether the Frequency will continue without end. Used in forecasting payments.
O	DayMonth		integer	Specifies the day of the month a contract payment is processed.
O	WeekMonth		integer	In combination with Days, specifies which occurrence of a particular day(s) in the month a payment will process. Example: If the Days specified a Monday, and the WeekMonth was 3, the payment would be processed on the 3rd Monday of the month. If two or more days are specified in the Days field, they might occur in different weeks. Each is caluclated as the 'nth' occurrence of that day in the month, where 'nth' is the WeekMonth.
R	Month		integer	The month of the year that a contract will process a contract payment.
O	Template		boolean	System field, specifie if this template is open to all merchants. It is not recommended that a frequency beset to 'template', as it affects other merchant's list items when selecting the Frequency in MyBridgePay.
O	Days		integer	Represents a string mask of the days in the format \"0100001\", where a 1 represents the day of the week that is selected. The example above would indicate Monday and Saturday are selected. The mask starts with Sunday as the first day of the week.
O	DayofMonth		integer	The day of the month a contract payment will be processed.
R	IntervalId		integer	Specifies the Interval period. The below options are available for the Interval Frequency. Pay close attention to the required fields for each; a contract will be processed if it does not have a valid Frequency. These values are listed below this table.

IntervalId Values:

•1–Daily: Requires only Frequency and IntervalId. Will occur every ‘nth’ number of days.
•2–Not Used:(Gives same results as weekly below, with same arguments).
•3–Weekly # Days: Requires IntervalId 3, Frequency, and Days. A selection of IntervalId 3, Frequency 2, and Days “0100010”, would produce the result every two weeks on Monday and Friday.
•4–Monthly # DayOfMonth: Requires IntervalId 4, the Frequency, and theDayMonth. An IntervalId 4 with a Frequencyof 1, and a DayMonth of 25 would occur on the 25th of every month.
•5–Monthly # Days WeekOfMonth: Requires IntervalId 5, Frequency, Days, WeekOfMonth. Will Occur on the ‘nth’ day of each of the Days in the days mask every nth month. So an IntervalId of 5, Frequency of 2, WeekMonth of 2, and Days mask of“0100010” would result in every two months on the 2nd Monday and 2nd Fridayof the month.
•6–Yearly # DayOfMonth Month: Requires IntervalId 6, Frequency, DayOfMonth, and Month. An IntervalId of6, DayMonth of 3, Month of 4, and Frequency of 2 would occur every 2 years on April the 3rd.
•7–Yearly # Days WeekOfMonth Month: Requires IntervalId 7, Frequency, Days, WeekOfMonth, and Month. An IntervalId of7, Frequency of 1, Days of “0100000”

\n","_postman_id":"eca3a6b1-052d-4060-ba1e-496929a8939f","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}},{"name":"Contracts","item":[{"name":"Contract","id":"837598b7-2133-4f33-b6f9-303cec184ee7","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-RB-MerchantId","type":"text","value":"{merchantAccountCode}"}],"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/contracts/{contractID}","description":"

GET: api/contracts/{id}
This returns a single Contract entity specified by the Id attribute on the end of the URL. Optionally, IncludeGraph=true can be added to the query string to return the SchedulePayments and Charges child collections. The BillingFrequency is always returned as part of the graph.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetContract
Purpose:	Returns the Entity for a given unique id wrapped in an IHttpActionResult.
Access:	{URL}
Method:	GET: api/Contracts/GetContract
Required Parameters:	Id - Unique id for the requested Entity. IncludeGraph - True/False whether to return the child entities of the Entity requested.

GET: api/contracts/

This returns an EntityList accepts any of the above fields as query string arguments inaddition to the default arguments.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetContracts
Purpose:	Returns the requested entities wrapped in an EntityList object which includes values for TotalCount, TotalPages, Page, Links, and Results, which contains a collection of the Entity.
Access:	{URL}
Method:	GET: api/Contracts/GetContracts
Required Parameters:	IncludeGraph - True/False whether to return the child entities of the entities requested. Page - The page or results to return. Page_Size - The size of the page of results to return, the default is 25. SearchFalse - True/False whether to search false values for boolean arguments in the query string. Entity - The Entity whose child properties can be used a filter values in the query string: ContractName, ProductId, MerchantId, BillingFrequencyId, AccountId, BillAmount, TaxAmount, AmountRemaining, CreatedOn, ModifiedOn, LastBillDate, NextBillDate, StartDat e, EndDate, NumFailures, MaxFailures, EmailCustomerAtFailure, EmailMerchantAtFailure, EmailCustomerReceipt, EmailMerchantReceip t, IsActive, and Status.

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["RecurringBilling.API","api","contracts"],"host":["www.bridgepaynetsecuretest.com"],"query":[{"disabled":true,"key":"Id","value":""},{"disabled":true,"key":"ContractName","value":""},{"disabled":true,"key":"ContractFilter","value":"{\"ContractCustomFields\":[{ \"CustomFieldConfigId\":8193, \"Value\":\"FIRSTY\"}]}"}],"variable":[]}},"response":[{"id":"f1fa0498-f470-4390-8386-79c8b28ca4be","name":"Contracts","originalRequest":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"},{"key":"X-RB-OrganizationId","value":"","type":"text","disabled":true}],"url":{"raw":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/contracts","protocol":"https","host":["www.bridgepaynetsecuretest.com"],"path":["RecurringBilling.API","api","contracts"],"query":[{"key":"Id","value":"","disabled":true},{"key":"ContractName","value":"","disabled":true},{"key":"ContractFilter","value":"{\"ContractCustomFields\":[{ \"CustomFieldConfigId\":8193, \"Value\":\"FIRSTY\"}]}","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Page\": 0,\r\n \"TotalPages\": 1,\r\n \"TotalCount\": 2,\r\n \"Results\": [\r\n {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contracts/24048\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contracts\",\r\n \"Rel\": \"newContract\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 24048,\r\n \"Name\": \"APItest\",\r\n \"ProductId\": 15232,\r\n \"MerchantId\": 13026001,\r\n \"BillingFrequencyId\": 18486,\r\n \"AccountId\": 31253,\r\n \"BillAmount\": 1000,\r\n \"TaxAmount\": null,\r\n \"AmountRemaining\": null,\r\n \"NumberOfPayments\": null,\r\n \"LastBillDate\": \"2023-03-13T04:00:00\",\r\n \"NextBillDate\": \"2023-03-14T04:00:00\",\r\n \"StartDate\": \"2022-06-04T04:00:00\",\r\n \"EndDate\": null,\r\n \"NumFailures\": null,\r\n \"MaxFailures\": null,\r\n \"RetryWaitTime\": null,\r\n \"EmailCustomerAtFailure\": false,\r\n \"EmailMerchantAtFailure\": false,\r\n \"EmailCustomerReceipt\": false,\r\n \"EmailMerchantReceipt\": false,\r\n \"IsActive\": true,\r\n \"Status\": null,\r\n \"CreatedBy\": \"Unknown\",\r\n \"LastModifiedBy\": \"sys\",\r\n \"ScheduledPayments\": [],\r\n \"Charges\": [],\r\n \"Product\": null,\r\n \"BillingFrequency\": null,\r\n \"Account\": null,\r\n \"ContractCustomFields\": null\r\n },\r\n {\r\n \"Links\": [\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contracts/29237\",\r\n \"Rel\": \"Self or Patch\",\r\n \"Method\": \"Get\",\r\n \"IsTemplated\": false\r\n },\r\n {\r\n \"Href\": \"https://www.bridgepaynetsecuretest.com/Bridgepay.RecurringBilling.API/api/contracts\",\r\n \"Rel\": \"newContract\",\r\n \"Method\": \"Post\",\r\n \"IsTemplated\": false\r\n }\r\n ],\r\n \"Id\": 29237,\r\n \"Name\": \"ContractNameTest1\",\r\n \"ProductId\": 15276,\r\n \"MerchantId\": 13026001,\r\n \"BillingFrequencyId\": 95,\r\n \"AccountId\": 37690,\r\n \"BillAmount\": 500000,\r\n \"TaxAmount\": 35000,\r\n \"AmountRemaining\": null,\r\n \"NumberOfPayments\": null,\r\n \"LastBillDate\": null,\r\n \"NextBillDate\": null,\r\n \"StartDate\": \"2022-10-24T00:00:00\",\r\n \"EndDate\": null,\r\n \"NumFailures\": null,\r\n \"MaxFailures\": 10,\r\n \"RetryWaitTime\": 1,\r\n \"EmailCustomerAtFailure\": null,\r\n \"EmailMerchantAtFailure\": null,\r\n \"EmailCustomerReceipt\": null,\r\n \"EmailMerchantReceipt\": null,\r\n \"IsActive\": false,\r\n \"Status\": null,\r\n \"CreatedBy\": \"noahmerchantaccount\",\r\n \"LastModifiedBy\": \"Unknown\",\r\n \"ScheduledPayments\": [],\r\n \"Charges\": [],\r\n \"Product\": null,\r\n \"BillingFrequency\": null,\r\n \"Account\": null,\r\n \"ContractCustomFields\": null\r\n }\r\n ],\r\n \"Links\": [],\r\n \"Exception\": null\r\n}"}],"_postman_id":"e049e6a0-4790-4adf-8da9-2ced8630d6c3"},{"name":"Create Contract","id":"91ad3f8d-39ce-4156-975a-0bc02646d42c","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-RB-MerchantId","type":"text","value":"{merchantAccountCode}"}],"body":{"mode":"raw","raw":"{\r\n\t\"Name\": \"ContractNameTest1\",\r\n\t\"ProductId\": 15276,\r\n\t\"IsActive\": false,\r\n\t\"MerchantId\": {merchantAccountCode},\r\n\t\"BillingFrequencyId\": 95,\r\n\t\"AccountId\": 37690,\r\n\t\"BillAmount\": 500000,\r\n\t\"TaxAmount\": 35000,\r\n\t\"AmountRemaining\": null,\r\n\t\"StartDate\": \"2022-10-24T00:00:00.000\",\r\n\t\"NumFailures\": 0,\r\n\t\"MaxFailures\": 10,\r\n\t\"MaxRetry\": 2,\r\n\t\"RetryWaitTime\": 1\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/contracts","description":"

POST: api/contracts/

This endpoint accepts a Contract entity, with an optional Account, Product, and BillingFrequency objects. Besure if adding an object to the graph to not include the corresponding entity Id for that object (for example if adding a BillingFrequency you would not include BillingFrequencyId or optionally set it to 0 which achieves the same thing as leaving it out of the Post body). Figure 6 shows an example Contract graph with a newBillingFrequency object. Notice that ProductId, AccountId are both set, but BillingFrequencyId is absentsince the graph contains a new BillingFrequency object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PostContract
Purpose:	Adds an entity to the database from the model provided. On success, returns the updated entity wrapped in an IHttpActionResult, with the Id value of the entity set.
Access:	{URL}
Method:	POST: api/Contracts/PostContract
Required Parameters:	Contract - The entity model to be inserted

PATCH: api/contracts/{id}
Specify the Id in the URL and any fields you want to update with Patch and all of the fields with Put.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PatchContract
Purpose:	Updates an entity based on the specified fields.
Access:	{URL}
Method:	[HttpPatch]
Required Parameters	Id - Unique id for the entity to be updated. Model - The entity modelt to be updated.

The contracts endpoint is the heart of the RecurringBilling system, so take special care when constructing and working with Contract entities and child elements.

Required	Property Name	Length	Data Type	Description
O	ProductId		integer	Optional if no Product is tied to the Contract; otherwise required.
O	Name		nvarchar	Optional but recommended, Contract name.
R	MerchantId	0-50	integer	Only relevant on POST and GET; you cannot update a MerchantId
R	BillingFrequencyId		integer	Required, can be omitted if a new child BillingFrequency is specified on a POST.
R	AccountId		integer	Can be omitted if a new Account is specified on the POST. If updating an Account as part of a graph, be sure to match up the AccountId with the ID of the Account entity off the Contract Object.
R	BillAmount		integer	The amount that will be charged each time the Billing Payment Service processes the recurring payment. The decimal is implied, so for $19.99 you would specify 1999 as the BillAmount.
R	TaxAmount		integer	The amount of any tax to include when processing a contract payment.
O	AmountRemaining		integer	Optional if the contract has no EndDate, otherwise required. When creating a Contract with an EndDate, this should be set to (total number of payments before end date * BillAmount + TaxAmount).
O	LastBilldate		datetime	Optional information; this field will be ignored if you enter a value for it into the API. For new Contracts, it is automatically set to the StartDate. For PATCH this field is ignored, even if populated. Dates expressed in ISO8601 format.
R	StartDate		datetime	Represents the start date for the contract.
O	EndDate		datetime	Optional but recommended if using AmountRemaining. Used in conjunction with Amount remaining to determine if a Contact has ended and the status needs to change.
O	NumFailures		integer	Current number of failed attempts to process a contract payment as of the last successful contract payment. It is reset to zero once a contract payment has processed.
O	IsActive		boolean	Default is false if not specified in POST.
O	MaxFailures		integer	Optional but recommended. The number of failures that can occur of unsuccessful payments to the contract before the Status is changed to Canceled.
O	RetryWaitTime		integer	Option but recommended. The number of days to wait after a contracted payment was declined before trying to process the payment again. If set to zero, attempt will be made the same day.
O	EmailCustomerAtFailure		boolean	Optional, default is false. Flag for email notifications.
O	EmailMerchantAtFailure		boolean	Optional, default is false. Flag for email notifications.
O	EmailCustomerReceipt		boolean	Optional, default is false. Flag for email notifications.
O	EmailMerchantReceipt		boolean	Optional, default is false. Flag for email notifications.
O	Status			Optional, default is 0, which is 'ready'. The full list of status values are listed below this table.

Status Values

•0–Ready. Contract will process normally.
•1–Approved. This status is ignored and is only used internally, it should not be used through the API.
•2–Error. Used internally to signify an error occurred during processing. The contract will be processed again next time the Billing Payment Service runs.
•3–Declined. Used to signify the contract payment was declined during the last processing attempt. Will not be processed again until the RetryWaitTime in days has passed since the LastBillDate.
•4–Canceled. Signifies that the MaxFailures was reached in processing a contract. The Contract will be set to IsActive and will no longer be processed.
•5–Processing. Signifies the Contract is currently processing a payment. It is not recommended that anything be changed if the contract is in this state.
•6–Deactivated. Manually deactivated for whatever reason. IsActive should beset to false.
•7–Complete. Signifies that the Contract EndDate has been reached and the AmountRemaining is now zero.

\n","_postman_id":"c4eded87-d75b-42bf-a864-767f54da52c5","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}},{"name":"ScheduledPayments","item":[{"name":"ScheduledPayment","id":"e0c274b6-dc57-4550-9d42-d19b3bbc5dc3","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"X-RB-MerchantId","value":"{merchantAccountCode}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/contracts/{contractID}/scheduledpayments/{scheduledPaymentsID}","description":"

GET: api/contacts/{contractid}/scheduledpayments/{id}
This returns a single Contact entity specified by the Id attribute on the end of the URL. Optionally, IncludeGraph=true can be added to the query string to return the Contract as well.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetScheduledPayment
Purpose:	Returns the Entity for a given unique id wrapped in an IHttpActionResult.
Access:	{URL}
Method:	GET: api/ScheduledPayments/{id}
Required Parameters:	ContractId- Unique id for the parent ContractModel Entity. Id - Unique id for the requested Entity. IncludeGraph - True/False whether to return the child entities of the Entity requested.

GET: api/contacts/{contractid}/scheduledpayments/
This returns an EntityList accepts any of the above arguments in addition to the default arguments.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	GetScheduledPayments
Purpose:	Returns the requested entities wrapped in a n EntityList object which includes values for TotalCount, TotalPages, Page, Links, and Results , which contains a collection of the Entity.
Access:	{URL}
Method:	GET: api/ScheduledPayments
Required Parameters:	ContractId- Unique id for the parent ContractModel Entity. IncludeGraph - True/False whether to return the child entities of the Entity requested. Page - The page or results to return. Page_Size - The size of the page of results to return, the default being 25. SearchFalse - True/False whether to search false values for boolean arguments in the query string. Entity - The entity whose child properites can be used as filter values in the query string: ContractId, BillDate, BillAmount, and Paid.

POST: api/contacts/{contractid}/scheduledpayments/
This endpoint accepts a ScheduledPayment entity. Figure 9, has an example of a ScheduledPayment entity post body.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PostScheduledPayment
Purpose:	Creates a ScheduledPayment entity.
Access:	{URL}
Method:	POST: api/ScheduledPayments
Required Parameters:	ScheduledPayment - The entity model to be inserted.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method:	PatchScheduledPayment
Purpose:	Updates an entity based on the specified fields. This method works for the Http method PATCH.
Access:	{URL}
Method:	[HttpPatch]
Required Parameters:	ContractId - Unique ID for the parent Contract of the entity to be updated. Id - Unique ID for the entity to be updated. Model - The entity model to be updated.

ScheduledPayments are one time payments scheduled on a Contract. They are processed bythe Billing Payment Process Service separately from the contract payments on the BillDate of the SchedulePayment. The ScheduledPayments endpoints are a layered endpoint and can only be accessed off a valid contract Id, which will return only the payments for that contract.

Note that ScheduledPayments are included in the count of max failures configured on a contract.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Requried	Property Name	DataType	Description
R	ContractId	Integer	Should match the ContractId in the URL.
R	BillDate	DateTime	The date the payment will process.
R	BillAmount	Integer	Amount of the one-time payment.
	Paid	boolean	Ignored. This is used by the processing system only and is ignored in PATCH/POST

","_postman_id":"31d1c17e-bd62-401a-a679-8d078410edba","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}},{"name":"Version Reporting","item":[{"name":"Recurring Billing API","event":[{"listen":"test","script":{"id":"d471365b-83f3-4f9e-9775-d2c3e5311bb9","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r",""],"type":"text/javascript"}}],"id":"85f88261-b836-4636-9826-b631a12b3090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/version","description":"

The GetVersion request returns the current version of the RecurringBillingAPI.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["RecurringBilling.API","api","version"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"18b172c2-205b-4e53-bc6a-39fc057630da","name":"Recurring Billing API","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.API/api/version"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ApplicationName\": \"Bridgepay.RecurringBilling.Api\",\n \"VersionNumber\": \"2022.2.0.70\"\n}"}],"_postman_id":"85f88261-b836-4636-9826-b631a12b3090"},{"name":"Recurring Billing Service","event":[{"listen":"test","script":{"id":"30adb403-8539-4ac6-9548-3ce8731cdf8b","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r",""],"type":"text/javascript"}}],"id":"bf00c3aa-aa45-44f0-b3bc-418755a444c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"\"http://bridgepaynetsecuretx.com/versionreporter/IVersionReporter/GetVersion\"","type":"text"}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.Service/VersionReporter.svc/v1","description":"

The VersionReporter service returns the current version of the RecurringBilling Service.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}},"urlObject":{"protocol":"https","path":["RecurringBilling.Service","VersionReporter.svc","v1"],"host":["www.bridgepaynetsecuretest.com"],"query":[],"variable":[]}},"response":[{"id":"3a1f331a-bc70-4b1c-8efa-6386c3bd82f9","name":"Recurring Billing Version","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml;charset=UTF-8","type":"text"},{"key":"SOAPAction","value":"\"http://bridgepaynetsecuretx.com/versionreporter/IVersionReporter/GetVersion\"","type":"text"}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n \r\n","options":{"raw":{"language":"xml"}}},"url":"https://www.bridgepaynetsecuretest.com/RecurringBilling.Service/VersionReporter.svc/v1"},"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n Bridgepay.RecurringBilling.Service\n 2022.2.0.63\n \n \n \n"}],"_postman_id":"bf00c3aa-aa45-44f0-b3bc-418755a444c9"}],"id":"995e9efd-5002-42eb-b4ab-06fa43e27619","description":"

The Recurring Billing API offers two methods to obtain the current version of the Recurring Billing API and Recurring Billing Service.

\n","_postman_id":"995e9efd-5002-42eb-b4ab-06fa43e27619","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}}],"id":"e8ce8a81-1370-4364-9967-84eba0524fac","description":"

The following section will outline the specific request layouts for the process flow described above.

\n","event":[{"listen":"prerequest","script":{"id":"2f9216e4-af23-4b4f-a155-923d700ff6fa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b2bfef6f-1ab6-4373-9d3d-bcff2d392a99","type":"text/javascript","exec":[""]}}],"_postman_id":"e8ce8a81-1370-4364-9967-84eba0524fac","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]},"isInherited":true,"source":{"_postman_id":"4e8b757f-1146-45ee-a531-5025f130f16c","id":"4e8b757f-1146-45ee-a531-5025f130f16c","name":"Recurring Billing API Development Guide","type":"collection"}}},{"name":"Appendix","item":[],"id":"82b5fbdf-52a5-4f7f-91da-5402f8f72660","description":"

Document Version:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Version:	Updated by:	Change(s):	Date:
1.0	Noah Hippensteel	Added Document Version Table.	09/09/2024

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"ff9a96ce-b45f-41bf-b339-700d4ad64832"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"9fe00b70-4ed2-4530-8663-57956ca22347"}}],"_postman_id":"82b5fbdf-52a5-4f7f-91da-5402f8f72660"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{username}"},{"key":"password","value":"{password}"}]}},"event":[{"listen":"prerequest","script":{"id":"f918a3b9-f83e-4d26-825b-e0d96a9f05de","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b516e483-9b17-4268-993a-6f4c2eff9ffb","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseURL","value":"www.bridgepaynetsecuretest.com","type":"string"},{"key":"merchantGroupID","value":"","type":"string"},{"key":"merchantAccountID","value":"","type":"string"},{"key":"merchantCode","value":"{merchantCode}","type":"string"},{"key":"merchantAccountCode","value":"{merchantAccountCode}","type":"string"},{"key":"username","value":"{username}","type":"string"},{"key":"password","value":"{password}","type":"string"},{"key":"accountID","value":"{accountID}","type":"string"},{"key":"addressID","value":"{addressID}","type":"string"},{"key":"contactID","value":"{contactID}","type":"string"},{"key":"accountHolderID","value":"{accountHolderID}","type":"string"},{"key":"walletID","value":"{walletID}","type":"string"},{"key":"paymentMethodID","value":"{paymentMethodID}","type":"string"},{"key":"productID","value":"{productID}","type":"string"},{"key":"frequencyID","value":"{frequencyID}","type":"string"},{"key":"contractID","value":"{contractID}","type":"string"},{"key":"scheduledPaymentsID","value":"{scheduledPaymentsID}","type":"string"},{"key":"walletSiteID","value":"{walletSiteID}","type":"string"}]}