BAbankofamerica
Contracts

Create a contract with a card token for a Merchant's Customer

Called by the Independent Software Vendor. Allows creating of contracts with card tokens.

post/merchants/{merchant_id}/contracts/card

Request

Path parameters

merchant_idstring required
Example:string

The merchant identifier that will be used to connect to the gateway. Size range - 1..16

Headers

Authorizationstring api_id:api_token required

Needs to include Basic word before Base64 encoded api_id:api_token. The api_id is the identifier of the organization created on TAP; size range - up to 36 characters. The api_token is the unique token previously generated by TAP and provided securely to the organization; size range - 32. Example: Basic ODA5BVgrNdZkZmbiFlJlTThkYTA2eG00MzA5dHh1bWZnZgfdZDE=

Acceptstring required
Example:application/vnd.paymentfusion.v3.0.0+json

Specifies the requested API version. If this field is not specified or has an invalid format, the API will return an error. If the specified version does not exist, a 404 page will be displayed. Accepted values - application/vnd.paymentfusion.v3.0.0+json

Content-Typestring required
Example:application/x-www-form-urlencoded

The Content-Type entity header is used to indicate the media type of the resource.

Request body application/x-www-form-urlencoded

bill_amountinteger required

Sets the monetary amount to charge on each cycle. Specified in USD.

start_datestring

Must be entered in YYYYMMDD format. If not set, the default value will be the date of tomorrow. For example, if today is 1/10/2009 and schedule=monthly then start_date will be set to 2/10/2009. If set to "next" the date of the next billing cycle will be used. For example, if today is 1/10/2009 and schedule=monthly then start_date will be set to 2/10/2009. Can also be entered as "first of month" or "last day of month".

schedulestring

Frequency of recurring billing schedule. Will be ignored if recurring is not sent as "true". Allowed values - "disabled","daily","weekly","bi-weekly", "monthly","bi-monthly","quarterly","bi-annually","annually". If set to "disabled" the contract will have the schedule set to "monthly" and status set to "disabled".

num_leftinteger

Number of transactions remaining in the recurring billing cycle. Will be ignored if recurring is not sent as "true". Can take the value of *, which is interpreted as recurring payment for unlimited time.

tokenstring required

The credit card token.

enabledboolean

Indicates whether the contract will be enabled or disabled when created.

Example request

{
  "start_date": "string",
  "schedule": "string",
  "token": "string"
}

Response

Success

vstring

The API version that was used to handle the request.

Example response

{
  "contract": {
    "customer_id": "string",
    "bill_amount": "string",
    "status": "string",
    "start_date": "string",
    "end_date": "string",
    "schedule": "string",
    "num_left": "string"
  },
  "v": "string"
}

Changes

No recorded changes to this operation across all 1 revision of this API.