B2B API Specification | North Developer

B2B Payment API

Recurring Payment

The PayTrace API allows you to create and manage recurring payments with your existing customers stored within the PayTrace customer database (Vault). Recurring Payments (transactions) will be processed as per the specified frequency until the transaction has been processed for the specified total count.

A unique ID will be assigned to the scheduled recurring payment when any recurring payment is created. This ID can be used to update, delete or export recurring payments.

Create Recurring Payment

post /v3/recurrence/create

This method allows you to create a recurring payment for an existing customer from your Customer Database (Vault) within PayTrace.

Parameters

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

merchant_id

integer

customer_id required

integer

Example:

123456789

recurrence required

object

surcharge_info

object

Example Request

{
  "merchant_id": "integer",
  "customer_id": 123456789,
  "recurrence": {
    "amount": 24.95,
    "frequency": "8",
    "start_date": "10/01/2024",
    "total_count": "12",
    "transaction_type": "Sale",
    "type": "C",
    "description": "Monthly fee for service.",
    "sec_code": "CCD",
    "weekend": "boolean",
    "repeat": "integer"
  },
  "surcharge_info": {
    "omit_surcharge": true
  }
}

Example Response

200 Successful Response

422 Validation Error

Delete Recurring Payment

delete /v3/recurrence

This method allows you to permanently delete an existing recurring payment with just the recurring payment ID.

Parameters

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

merchant_id

integer

recurrence required

object

Example Request

{
  "merchant_id": "integer",
  "recurrence": {
    "id": "123456"
  }
}

Example Response

200 Successful Response

422 Validation Error

Update Recurring Payment

patch /v3/recurrence

This method allows you to modify an existing recurring payment using a recurring payment ID.

Parameters

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

merchant_id

integer

recurrence required

object

next_date

string

Example:

05/01/2024

surcharge_info

object

customer_id

integer

Example:

234585761

Example Request

{
  "merchant_id": "integer",
  "recurrence": {
    "amount": 80.05,
    "frequency": "8",
    "total_count": "12",
    "transaction_type": "Sale",
    "type": "C",
    "description": "Monthly fee for service.",
    "sec_code": "CCD",
    "weekend": "boolean",
    "repeat": "integer",
    "id": "123456"
  },
  "next_date": "05/01/2024",
  "surcharge_info": {
    "omit_surcharge": true
  },
  "customer_id": 234585761
}

Example Response

200 Successful Response

422 Validation Error

Export a List of Recurring Payments

get /v3/recurrence/export/by-customer/{customer_id}

This method can be used to export a list of recurring payments for a specific customer.

Parameters

customer_id required

integer

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Example Response

200 Successful Response

422 Validation Error

Export Recurring Payments

post /v3/recurrence/export/by-customer/{customer_id}

This method can be used to export a single recurring payment or all recurring payments for a specific customer.

Parameters

customer_id required

integer

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

merchant_id

integer

customer_label

string

Maximum:

Example:

customer_label21New

recurrence

object

limit

integer

Default:

offset

integer

Default:

Example Request

{
  "merchant_id": "integer",
  "customer_label": "customer_label21New",
  "recurrence": {
    "id": "123456"
  },
  "limit": 50,
  "offset": 0
}

Example Response

200 Successful Response

422 Validation Error

Export a Single Recurring Payment by ID

get /v3/recurrence/export/by-id/{recurrence_id}

This method can be used to export a single recurring payment by recurring payment ID.

Parameters

recurrence_id required

integer

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Example Response

200 Successful Response

422 Validation Error

Export a Single Recurring Payments

post /v3/recurrence/export/approved/by-customer/{customer_id}

This method can be used to export the most recent approved recurring payment transaction based on the specified customer profile.

Parameters

customer_id required

integer

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Example Response

200 Successful Response

422 Validation Error