paystack-customers - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /paystack-customers | Type: Application | PCID required: Yes

Tools

Tool	Description
`paystack_customers_customer_create`	Create Customer
`paystack_customers_customer_deactivate_authorization`	Deactivate Authorization
`paystack_customers_customer_direct_debit_activation_charge`	Direct Debit Activation Charge
`paystack_customers_customer_fetch`	Fetch Customer
`paystack_customers_customer_fetch_mandate_authorizations`	Fetch Mandate Authorizations
`paystack_customers_customer_initialize_authorization`	Initialize Authorization
`paystack_customers_customer_initialize_direct_debit`	Initialize Direct Debit
`paystack_customers_customer_list`	List Customers
`paystack_customers_customer_risk_action`	Set Risk Action
`paystack_customers_customer_update`	Update Customer
`paystack_customers_customer_validate`	Validate Customer
`paystack_customers_customer_verify_authorization`	Verify Authorization
`paystack_customers_dedicated_account_add_split`	Split Dedicated Account Transaction
`paystack_customers_dedicated_account_assign`	Assign Dedicated Account
`paystack_customers_dedicated_account_available_providers`	Fetch Bank Providers
`paystack_customers_dedicated_account_create`	Create Dedicated Account
`paystack_customers_dedicated_account_deactivate`	Deactivate Dedicated Account
`paystack_customers_dedicated_account_fetch`	Fetch Dedicated Account
`paystack_customers_dedicated_account_list`	List Dedicated Accounts
`paystack_customers_dedicated_account_remove_split`	Remove Split from Dedicated Account
`paystack_customers_dedicated_account_requery`	Requery Dedicated Account
`paystack_customers_directdebit_list_mandate_authorizations`	List Mandate Authorizations
`paystack_customers_directdebit_trigger_activation_charge`	Trigger Activation Charge
`paystack_customers_plan_create`	Create Plan
`paystack_customers_plan_fetch`	Fetch Plan
`paystack_customers_plan_list`	List Plans
`paystack_customers_plan_update`	Update Plan
`paystack_customers_subaccount_create`	Create Subaccount
`paystack_customers_subaccount_fetch`	Fetch Subaccount
`paystack_customers_subaccount_list`	List Subaccounts
`paystack_customers_subaccount_update`	Update Subaccount
`paystack_customers_subscription_create`	Create Subscription
`paystack_customers_subscription_disable`	Disable Subscription
`paystack_customers_subscription_enable`	Enable Subscription
`paystack_customers_subscription_fetch`	Fetch Subscription
`paystack_customers_subscription_list`	List Subscriptions
`paystack_customers_subscription_manage_email`	Send Update Subscription Link
`paystack_customers_subscription_manage_link`	Generate Update Subscription Link

paystack_customers_customer_create

Create Customer Parameters:

Parameter	Type	Required	Default	Description
`email`	string	Yes	—	Customer’s email address
`first_name`	string	No	—	Customer’s first name
`last_name`	string	No	—	Customer’s last name
`metadata`	string	No	—	Stringified JSON object of custom data
`phone`	string	No	—	Customer’s phone number

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "email": {
      "type": "string",
      "description": "Customer's email address"
    },
    "first_name": {
      "type": "string",
      "description": "Customer's first name"
    },
    "last_name": {
      "type": "string",
      "description": "Customer's last name"
    },
    "metadata": {
      "type": "string",
      "description": "Stringified JSON object of custom data"
    },
    "phone": {
      "type": "string",
      "description": "Customer's phone number"
    }
  },
  "required": [
    "PCID",
    "email"
  ]
}

paystack_customers_customer_deactivate_authorization

Deactivate Authorization Parameters:

Parameter	Type	Required	Default	Description
`authorization_code`	string	Yes	—	Authorization code to be deactivated

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "authorization_code": {
      "type": "string",
      "description": "Authorization code to be deactivated"
    }
  },
  "required": [
    "PCID",
    "authorization_code"
  ]
}

paystack_customers_customer_direct_debit_activation_charge

Direct Debit Activation Charge Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The customer ID attached to the authorization
`authorization_id`	integer	Yes	—	The authorization ID gotten from the initiation response

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The customer ID attached to the authorization"
    },
    "authorization_id": {
      "type": "integer",
      "description": "The authorization ID gotten from the initiation response"
    }
  },
  "required": [
    "PCID",
    "id",
    "authorization_id"
  ]
}

paystack_customers_customer_fetch

Fetch Customer Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	The code for the customer gotten from the response of the customer creation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "The code for the customer gotten from the response of the customer creation"
    }
  },
  "required": [
    "PCID",
    "code"
  ]
}

paystack_customers_customer_fetch_mandate_authorizations

Fetch Mandate Authorizations Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The customer ID for the authorizations to fetch

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The customer ID for the authorizations to fetch"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

paystack_customers_customer_initialize_authorization

Initialize Authorization Parameters:

Parameter	Type	Required	Default	Description
`account`	object	No	—	The account value
`address`	object	No	—	The address value
`callback_url`	string	No	—	Fully qualified url (e.g. https://example.com/) to redirect your customer to
`channel`	string	Yes	—	direct_debit is the only supported option for now
`email`	string	Yes	—	Customer’s email address

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "account": {
      "type": "object",
      "description": "The account value",
      "properties": {
        "number": {
          "type": "string",
          "description": "The customer's account number"
        },
        "bank_code": {
          "type": "string",
          "description": "The code representing the customer's bank"
        }
      },
      "required": [
        "number",
        "bank_code"
      ]
    },
    "address": {
      "type": "object",
      "description": "The address value",
      "properties": {
        "street": {
          "type": "string",
          "description": "The customer's street"
        },
        "city": {
          "type": "string",
          "description": "The customer's city"
        },
        "state": {
          "type": "string",
          "description": "The customer's state"
        }
      },
      "required": [
        "street",
        "city",
        "state"
      ]
    },
    "callback_url": {
      "type": "string",
      "description": "Fully qualified url (e.g. https://example.com/) to redirect your customer to"
    },
    "channel": {
      "type": "string",
      "description": "direct_debit is the only supported option for now",
      "enum": [
        "direct_debit"
      ]
    },
    "email": {
      "type": "string",
      "description": "Customer's email address"
    }
  },
  "required": [
    "PCID",
    "channel",
    "email"
  ]
}

paystack_customers_customer_initialize_direct_debit

Initialize Direct Debit Parameters:

Parameter	Type	Required	Default	Description
`id`	integer	Yes	—	The ID of the customer to initialize the direct debit for
`account`	object	Yes	—	The account value
`address`	object	Yes	—	The address value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the customer to initialize the direct debit for"
    },
    "account": {
      "type": "object",
      "description": "The account value",
      "properties": {
        "number": {
          "type": "string",
          "description": "The customer's account number"
        },
        "bank_code": {
          "type": "string",
          "description": "The code representing the customer's bank"
        }
      },
      "required": [
        "number",
        "bank_code"
      ]
    },
    "address": {
      "type": "object",
      "description": "The address value",
      "properties": {
        "street": {
          "type": "string",
          "description": "The customer's street"
        },
        "city": {
          "type": "string",
          "description": "The customer's city"
        },
        "state": {
          "type": "string",
          "description": "The customer's state"
        }
      },
      "required": [
        "street",
        "city",
        "state"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "account",
    "address"
  ]
}

paystack_customers_customer_list

List Customers Parameters:

Parameter	Type	Required	Default	Description
`use_cursor`	boolean	No	—	A flag to indicate if cursor based pagination should be used
`next`	string	No	—	An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data
`previous`	string	No	—	An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data
`from`	string	No	—	The start date
`to`	string	No	—	The end date
`perPage`	integer	No	—	The number of records to fetch per request
`page`	integer	No	—	The offset to retrieve data from

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "use_cursor": {
      "type": "boolean",
      "description": "A flag to indicate if cursor based pagination should be used"
    },
    "next": {
      "type": "string",
      "description": "An alphanumeric value returned for every cursor based retrieval, used to retrieve the next set of data"
    },
    "previous": {
      "type": "string",
      "description": "An alphanumeric value returned for every cursor based retrieval, used to retrieve the previous set of data"
    },
    "from": {
      "type": "string",
      "description": "The start date"
    },
    "to": {
      "type": "string",
      "description": "The end date"
    },
    "perPage": {
      "type": "integer",
      "description": "The number of records to fetch per request"
    },
    "page": {
      "type": "integer",
      "description": "The offset to retrieve data from"
    }
  },
  "required": [
    "PCID"
  ]
}

paystack_customers_customer_risk_action

Set Risk Action Parameters:

Parameter	Type	Required	Default	Description
`customer`	string	Yes	—	The customer code from the response of the customer creation
`risk_action`	string	No	—	This determines the fraud rules that should be applied to the customer

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "customer": {
      "type": "string",
      "description": "The customer code from the response of the customer creation"
    },
    "risk_action": {
      "type": "string",
      "description": "This determines the fraud rules that should be applied to the customer",
      "enum": [
        "allow",
        "deny",
        "default"
      ]
    }
  },
  "required": [
    "PCID",
    "customer"
  ]
}

paystack_customers_customer_update

Update Customer Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	The code for the customer gotten from the response of the customer creation
`first_name`	string	No	—	Customer’s first name
`last_name`	string	No	—	Customer’s last name
`metadata`	string	No	—	Stringified JSON object of custom data
`phone`	string	No	—	Customer’s phone number

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "The code for the customer gotten from the response of the customer creation"
    },
    "first_name": {
      "type": "string",
      "description": "Customer's first name"
    },
    "last_name": {
      "type": "string",
      "description": "Customer's last name"
    },
    "metadata": {
      "type": "string",
      "description": "Stringified JSON object of custom data"
    },
    "phone": {
      "type": "string",
      "description": "Customer's phone number"
    }
  },
  "required": [
    "PCID",
    "code"
  ]
}

paystack_customers_customer_validate

Validate Customer Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	The code for the customer gotten from the response of the customer creation
`account_number`	string	Yes	—	Customer’s bank account number.
`bank_code`	string	Yes	—	You can get the list of bank codes by calling the List Banks endpoint (https://api.paystack.co/bank).
`bvn`	string	Yes	—	Customer’s Bank Verification Number
`country`	string	Yes	—	Two-letter country code of identification issuer
`first_name`	string	Yes	—	Customer’s first name
`last_name`	string	Yes	—	Customer’s last name
`middle_name`	string	No	—	Customer’s middle name
`type`	string	Yes	—	Predefined types of identification.
`value`	string	No	—	Customer’s identification number.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "The code for the customer gotten from the response of the customer creation"
    },
    "account_number": {
      "type": "string",
      "description": "Customer's bank account number."
    },
    "bank_code": {
      "type": "string",
      "description": "You can get the list of bank codes by calling the List Banks endpoint (https://api.paystack.co/bank)."
    },
    "bvn": {
      "type": "string",
      "description": "Customer's Bank Verification Number"
    },
    "country": {
      "type": "string",
      "description": "Two-letter country code of identification issuer"
    },
    "first_name": {
      "type": "string",
      "description": "Customer's first name"
    },
    "last_name": {
      "type": "string",
      "description": "Customer's last name"
    },
    "middle_name": {
      "type": "string",
      "description": "Customer's middle name"
    },
    "type": {
      "type": "string",
      "description": "Predefined types of identification."
    },
    "value": {
      "type": "string",
      "description": "Customer's identification number."
    }
  },
  "required": [
    "PCID",
    "code",
    "account_number",
    "bank_code",
    "bvn",
    "country",
    "first_name",
    "last_name",
    "type"
  ]
}

paystack_customers_customer_verify_authorization

Verify Authorization Parameters:

Parameter	Type	Required	Default	Description
`reference`	string	Yes	—	The reference returned in the initialization response

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "reference": {
      "type": "string",
      "description": "The reference returned in the initialization response"
    }
  },
  "required": [
    "PCID",
    "reference"
  ]
}

paystack_customers_dedicated_account_add_split

Split Dedicated Account Transaction Parameters:

Parameter	Type	Required	Default	Description
`account_number`	string	Yes	—	Valid Dedicated virtual account
`split_code`	string	No	—	Split code consisting of the lists of accounts you want to split the transaction with
`subaccount`	string	No	—	Subaccount code of the account you want to split the transaction with

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "account_number": {
      "type": "string",
      "description": "Valid Dedicated virtual account"
    },
    "split_code": {
      "type": "string",
      "description": "Split code consisting of the lists of accounts you want to split the transaction with"
    },
    "subaccount": {
      "type": "string",
      "description": "Subaccount code of the account you want to split the transaction with"
    }
  },
  "required": [
    "PCID",
    "account_number"
  ]
}

paystack_customers_dedicated_account_assign

Assign Dedicated Account Parameters:

Parameter	Type	Required	Default	Description
`account_number`	string	No	—	Customer’s account number
`bank_code`	string	No	—	Customer’s bank code
`bvn`	string	No	—	Customer’s Bank Verification Number
`country`	string	Yes	—	The two letter code country
`email`	string	Yes	—	Customer’s email address
`first_name`	string	Yes	—	Customer’s first name
`last_name`	string	Yes	—	Customer’s last name
`phone`	string	Yes	—	Customer’s phone name
`preferred_bank`	string	Yes	—	The bank slug for preferred bank. To get a list of available banks, use the List Banks endpoint, passing `pay_with_bank_transfer=true` query parameter
`split_code`	string	No	—	Split code consisting of the lists of accounts you want to split the transaction with
`subaccount`	string	No	—	Subaccount code of the account you want to split the transaction with

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "account_number": {
      "type": "string",
      "description": "Customer's account number"
    },
    "bank_code": {
      "type": "string",
      "description": "Customer's bank code"
    },
    "bvn": {
      "type": "string",
      "description": "Customer's Bank Verification Number"
    },
    "country": {
      "type": "string",
      "description": "The two letter code country",
      "enum": [
        "NG",
        "GH"
      ]
    },
    "email": {
      "type": "string",
      "description": "Customer's email address"
    },
    "first_name": {
      "type": "string",
      "description": "Customer's first name"
    },
    "last_name": {
      "type": "string",
      "description": "Customer's last name"
    },
    "phone": {
      "type": "string",
      "description": "Customer's phone name"
    },
    "preferred_bank": {
      "type": "string",
      "description": "The bank slug for preferred bank. To get a list of available banks,  use the List Banks endpoint, passing `pay_with_bank_transfer=true` query parameter"
    },
    "split_code": {
      "type": "string",
      "description": "Split code consisting of the lists of accounts you want to split the transaction with"
    },
    "subaccount": {
      "type": "string",
      "description": "Subaccount code of the account you want to split the transaction with"
    }
  },
  "required": [
    "PCID",
    "country",
    "email",
    "first_name",
    "last_name",
    "phone",
    "preferred_bank"
  ]
}

paystack_customers_dedicated_account_available_providers

Fetch Bank Providers

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

paystack_customers_dedicated_account_create

Create Dedicated Account Parameters:

Parameter	Type	Required	Default	Description
`customer`	string	Yes	—	The code for the previously created customer
`preferred_bank`	string	No	—	The bank slug for preferred bank. To get a list of available banks, use the List Providers endpoint
`split_code`	string	No	—	Split code consisting of the lists of accounts you want to split the transaction with
`subaccount`	string	No	—	Subaccount code of the account you want to split the transaction with

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "customer": {
      "type": "string",
      "description": "The code for the previously created customer"
    },
    "preferred_bank": {
      "type": "string",
      "description": "The bank slug for preferred bank. To get a list of available banks, use the List Providers endpoint"
    },
    "split_code": {
      "type": "string",
      "description": "Split code consisting of the lists of accounts you want to split the transaction with"
    },
    "subaccount": {
      "type": "string",
      "description": "Subaccount code of the account you want to split the transaction with"
    }
  },
  "required": [
    "PCID",
    "customer"
  ]
}

paystack_customers_dedicated_account_deactivate

Deactivate Dedicated Account Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	ID of dedicated virtual account

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "ID of dedicated virtual account"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

paystack_customers_dedicated_account_fetch

Fetch Dedicated Account Parameters:

Parameter	Type	Required	Default	Description
`id`	string	Yes	—	ID of dedicated virtual account

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "ID of dedicated virtual account"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

paystack_customers_dedicated_account_list

List Dedicated Accounts Parameters:

Parameter	Type	Required	Default	Description
`active`	boolean	No	—	Status of the dedicated virtual account
`customer`	integer	No	—	The customer’s ID
`currency`	string	No	—	The currency of the dedicated virtual account
`provider_slug`	string	No	—	The bank’s slug in lowercase, without spaces
`bank_id`	string	No	—	The bank’s ID
`perPage`	integer	No	—	The number of records to fetch per request
`page`	integer	No	—	The offset to retrieve data from

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "active": {
      "type": "boolean",
      "description": "Status of the dedicated virtual account"
    },
    "customer": {
      "type": "integer",
      "description": "The customer's ID"
    },
    "currency": {
      "type": "string",
      "description": "The currency of the dedicated virtual account",
      "enum": [
        "NGN",
        "GHS"
      ]
    },
    "provider_slug": {
      "type": "string",
      "description": "The bank's slug in lowercase, without spaces"
    },
    "bank_id": {
      "type": "string",
      "description": "The bank's ID"
    },
    "perPage": {
      "type": "integer",
      "description": "The number of records to fetch per request"
    },
    "page": {
      "type": "integer",
      "description": "The offset to retrieve data from"
    }
  },
  "required": [
    "PCID"
  ]
}

paystack_customers_dedicated_account_remove_split

Remove Split from Dedicated Account Parameters:

Parameter	Type	Required	Default	Description
`account_number`	string	Yes	—	Valid Dedicated virtual account

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "account_number": {
      "type": "string",
      "description": "Valid Dedicated virtual account"
    }
  },
  "required": [
    "PCID",
    "account_number"
  ]
}

paystack_customers_dedicated_account_requery

Requery Dedicated Account Parameters:

Parameter	Type	Required	Default	Description
`account_number`	string	No	—	Virtual account number to requery
`provider_slug`	string	No	—	The bank’s slug in lowercase, without spaces.
`date`	string	No	—	The day the transfer was made

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "account_number": {
      "type": "string",
      "description": "Virtual account number to requery"
    },
    "provider_slug": {
      "type": "string",
      "description": "The bank's slug in lowercase, without spaces."
    },
    "date": {
      "type": "string",
      "description": "The day the transfer was made"
    }
  },
  "required": [
    "PCID"
  ]
}

paystack_customers_directdebit_list_mandate_authorizations

List Mandate Authorizations Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	The cursor value of the next set of authorizations to fetch. You can get this from the meta object of the response
`status`	string	No	—	Filter by the authorization status
`per_page`	integer	No	—	The number of authorizations to fetch per request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "The cursor value of the next set of authorizations to fetch. You can get this from the meta object of the response"
    },
    "status": {
      "type": "string",
      "description": "Filter by the authorization status",
      "enum": [
        "pending",
        "active",
        "revoked"
      ]
    },
    "per_page": {
      "type": "integer",
      "description": "The number of authorizations to fetch per request"
    }
  },
  "required": [
    "PCID"
  ]
}

paystack_customers_directdebit_trigger_activation_charge

Trigger Activation Charge Parameters:

Parameter	Type	Required	Default	Description
`customer_ids`	integer[]	Yes	—	Array of customer IDs to trigger activation charge for

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "customer_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Array of customer IDs to trigger activation charge for"
    }
  },
  "required": [
    "PCID",
    "customer_ids"
  ]
}

paystack_customers_plan_create

Create Plan Parameters:

Parameter	Type	Required	Default	Description
`amount`	integer	Yes	—	Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
`currency`	string	No	—	Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD
`description`	string	No	—	A description for this plan
`interval`	string	Yes	—	Payment interval
`invoice_limit`	integer	No	—	Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing.
`name`	string	Yes	—	Name of plan
`send_invoices`	boolean	No	—	Set to false if you don’t want invoices to be sent to your customers
`send_sms`	boolean	No	—	Set to false if you don’t want text messages to be sent to your customers

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "amount": {
      "type": "integer",
      "description": "Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR"
    },
    "currency": {
      "type": "string",
      "description": "Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD"
    },
    "description": {
      "type": "string",
      "description": "A description for this plan"
    },
    "interval": {
      "type": "string",
      "description": "Payment interval",
      "enum": [
        "daily",
        "weekly",
        "monthly",
        "biannually",
        "annually"
      ]
    },
    "invoice_limit": {
      "type": "integer",
      "description": "Number of invoices to raise during subscription to this plan.  Can be overridden by specifying an invoice_limit while subscribing."
    },
    "name": {
      "type": "string",
      "description": "Name of plan"
    },
    "send_invoices": {
      "type": "boolean",
      "description": "Set to false if you don't want invoices to be sent to your customers"
    },
    "send_sms": {
      "type": "boolean",
      "description": "Set to false if you don't want text messages to be sent to your customers"
    }
  },
  "required": [
    "PCID",
    "amount",
    "interval",
    "name"
  ]
}

paystack_customers_plan_fetch

Fetch Plan Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	The plan code you want to fetch

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "The plan code you want to fetch"
    }
  },
  "required": [
    "PCID",
    "code"
  ]
}

paystack_customers_plan_list

List Plans Parameters:

Parameter	Type	Required	Default	Description
`perPage`	integer	No	—	Number of records to fetch per page
`page`	integer	No	—	The section to retrieve
`interval`	string	No	—	Specify interval of the plan
`amount`	integer	No	—	The amount on the plans to retrieve
`from`	string	No	—	The start date
`to`	string	No	—	The end date

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "perPage": {
      "type": "integer",
      "description": "Number of records to fetch per page"
    },
    "page": {
      "type": "integer",
      "description": "The section to retrieve"
    },
    "interval": {
      "type": "string",
      "description": "Specify interval of the plan",
      "enum": [
        "daily",
        "weekly",
        "monthly",
        "biannually",
        "annually"
      ]
    },
    "amount": {
      "type": "integer",
      "description": "The amount on the plans to retrieve"
    },
    "from": {
      "type": "string",
      "description": "The start date"
    },
    "to": {
      "type": "string",
      "description": "The end date"
    }
  },
  "required": [
    "PCID"
  ]
}

paystack_customers_plan_update

Update Plan Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	The plan code you want to fetch
`amount`	integer	No	—	Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
`currency`	string	No	—	Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD
`description`	string	No	—	A description for this plan
`interval`	string	No	—	Payment interval
`invoice_limit`	integer	No	—	Number of invoices to raise during subscription to this plan. Can be overridden by specifying an invoice_limit while subscribing.
`name`	string	No	—	Name of plan
`send_invoices`	boolean	No	—	Set to false if you don’t want invoices to be sent to your customers
`send_sms`	boolean	No	—	Set to false if you don’t want text messages to be sent to your customers

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "The plan code you want to fetch"
    },
    "amount": {
      "type": "integer",
      "description": "Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR"
    },
    "currency": {
      "type": "string",
      "description": "Currency in which amount is set. Allowed values are NGN, GHS, ZAR or USD"
    },
    "description": {
      "type": "string",
      "description": "A description for this plan"
    },
    "interval": {
      "type": "string",
      "description": "Payment interval",
      "enum": [
        "daily",
        "weekly",
        "monthly",
        "biannually",
        "annually"
      ]
    },
    "invoice_limit": {
      "type": "integer",
      "description": "Number of invoices to raise during subscription to this plan.  Can be overridden by specifying an invoice_limit while subscribing."
    },
    "name": {
      "type": "string",
      "description": "Name of plan"
    },
    "send_invoices": {
      "type": "boolean",
      "description": "Set to false if you don't want invoices to be sent to your customers"
    },
    "send_sms": {
      "type": "boolean",
      "description": "Set to false if you don't want text messages to be sent to your customers"
    }
  },
  "required": [
    "PCID",
    "code"
  ]
}

paystack_customers_subaccount_create

Create Subaccount Parameters:

Parameter	Type	Required	Default	Description
`account_number`	string	Yes	—	Bank account number
`business_name`	string	Yes	—	Name of business for subaccount
`description`	string	No	—	A description for this subaccount
`metadata`	string	No	—	Stringified JSON object of custom data
`percentage_charge`	number	Yes	—	The percentage charge on transactions for this subaccount
`primary_contact_email`	string	No	—	A contact email for the subaccount
`primary_contact_name`	string	No	—	The name of the contact person for this subaccount
`primary_contact_phone`	string	No	—	A phone number to call for this subaccount
`settlement_bank`	string	Yes	—	Bank code for the bank. You can get the list of Bank Codes by calling the List Banks endpoint.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "account_number": {
      "type": "string",
      "description": "Bank account number"
    },
    "business_name": {
      "type": "string",
      "description": "Name of business for subaccount"
    },
    "description": {
      "type": "string",
      "description": "A description for this subaccount"
    },
    "metadata": {
      "type": "string",
      "description": "Stringified JSON object of custom data"
    },
    "percentage_charge": {
      "type": "number",
      "description": "The percentage charge on transactions for this subaccount"
    },
    "primary_contact_email": {
      "type": "string",
      "description": "A contact email for the subaccount"
    },
    "primary_contact_name": {
      "type": "string",
      "description": "The name of the contact person for this subaccount"
    },
    "primary_contact_phone": {
      "type": "string",
      "description": "A phone number to call for this subaccount"
    },
    "settlement_bank": {
      "type": "string",
      "description": "Bank code for the bank. You can get the list of Bank Codes by calling the List Banks endpoint."
    }
  },
  "required": [
    "PCID",
    "account_number",
    "business_name",
    "percentage_charge",
    "settlement_bank"
  ]
}

paystack_customers_subaccount_fetch

Fetch Subaccount Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	The subaccount code you want to fetch

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "The subaccount code you want to fetch"
    }
  },
  "required": [
    "PCID",
    "code"
  ]
}

paystack_customers_subaccount_list

List Subaccounts Parameters:

Parameter	Type	Required	Default	Description
`perPage`	integer	No	—	Number of records to fetch per request
`page`	integer	No	—	The offset to retrieve data from
`active`	boolean	No	—	Filter by the state of the subaccounts

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "perPage": {
      "type": "integer",
      "description": "Number of records to fetch per request"
    },
    "page": {
      "type": "integer",
      "description": "The offset to retrieve data from"
    },
    "active": {
      "type": "boolean",
      "description": "Filter by the state of the subaccounts"
    }
  },
  "required": [
    "PCID"
  ]
}

paystack_customers_subaccount_update

Update Subaccount Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	The subaccount code you want to fetch
`account_number`	string	No	—	Bank account number
`active`	boolean	No	—	Activate or deactivate a subaccount
`business_name`	string	No	—	Name of business for subaccount
`description`	string	No	—	A description for this subaccount
`metadata`	string	No	—	Stringified JSON object of custom data
`percentage_charge`	number	No	—	Customer’s phone number
`primary_contact_email`	string	No	—	A contact email for the subaccount
`primary_contact_name`	string	No	—	The name of the contact person for this subaccount
`primary_contact_phone`	string	No	—	A phone number to call for this subaccount
`settlement_bank`	string	No	—	Bank code for the bank. You can get the list of Bank Codes by calling the List Banks endpoint.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "The subaccount code you want to fetch"
    },
    "account_number": {
      "type": "string",
      "description": "Bank account number"
    },
    "active": {
      "type": "boolean",
      "description": "Activate or deactivate a subaccount"
    },
    "business_name": {
      "type": "string",
      "description": "Name of business for subaccount"
    },
    "description": {
      "type": "string",
      "description": "A description for this subaccount"
    },
    "metadata": {
      "type": "string",
      "description": "Stringified JSON object of custom data"
    },
    "percentage_charge": {
      "type": "number",
      "description": "Customer's phone number"
    },
    "primary_contact_email": {
      "type": "string",
      "description": "A contact email for the subaccount"
    },
    "primary_contact_name": {
      "type": "string",
      "description": "The name of the contact person for this subaccount"
    },
    "primary_contact_phone": {
      "type": "string",
      "description": "A phone number to call for this subaccount"
    },
    "settlement_bank": {
      "type": "string",
      "description": "Bank code for the bank. You can get the list of Bank Codes by calling the List Banks endpoint."
    }
  },
  "required": [
    "PCID",
    "code"
  ]
}

paystack_customers_subscription_create

Create Subscription Parameters:

Parameter	Type	Required	Default	Description
`authorization`	string	No	—	If customer has multiple authorizations, you can set the desired authorization you wish to use for this subscription here. If this is not supplied, the customer’s most recent authorization would be used
`customer`	string	Yes	—	Customer’s email address or customer code
`plan`	string	Yes	—	Plan code
`start_date`	string	No	—	Set the date for the first debit. (ISO 8601 format) e.g. 2017-05-16T00:30:13+01:00

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "authorization": {
      "type": "string",
      "description": "If customer has multiple authorizations, you can set the desired authorization you wish to use for this subscription here.  If this is not supplied, the customer's most recent authorization would be used"
    },
    "customer": {
      "type": "string",
      "description": "Customer's email address or customer code"
    },
    "plan": {
      "type": "string",
      "description": "Plan code"
    },
    "start_date": {
      "type": "string",
      "description": "Set the date for the first debit. (ISO 8601 format) e.g. 2017-05-16T00:30:13+01:00"
    }
  },
  "required": [
    "PCID",
    "customer",
    "plan"
  ]
}

paystack_customers_subscription_disable

Disable Subscription Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	Subscription code
`token`	string	Yes	—	Email token

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "Subscription code"
    },
    "token": {
      "type": "string",
      "description": "Email token"
    }
  },
  "required": [
    "PCID",
    "code",
    "token"
  ]
}

paystack_customers_subscription_enable

Enable Subscription Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	Subscription code
`token`	string	Yes	—	Email token

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "Subscription code"
    },
    "token": {
      "type": "string",
      "description": "Email token"
    }
  },
  "required": [
    "PCID",
    "code",
    "token"
  ]
}

paystack_customers_subscription_fetch

Fetch Subscription Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	The subscription code for the subscription you want to fetch

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "The subscription code for the subscription you want to fetch"
    }
  },
  "required": [
    "PCID",
    "code"
  ]
}

paystack_customers_subscription_list

List Subscriptions Parameters:

Parameter	Type	Required	Default	Description
`perPage`	integer	No	—	Number of records to fetch per page
`page`	integer	No	—	The section to retrieve
`plan`	integer	No	—	Plan ID
`customer`	string	No	—	Customer ID
`from`	string	No	—	The start date
`to`	string	No	—	The end date

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "perPage": {
      "type": "integer",
      "description": "Number of records to fetch per page"
    },
    "page": {
      "type": "integer",
      "description": "The section to retrieve"
    },
    "plan": {
      "type": "integer",
      "description": "Plan ID"
    },
    "customer": {
      "type": "string",
      "description": "Customer ID"
    },
    "from": {
      "type": "string",
      "description": "The start date"
    },
    "to": {
      "type": "string",
      "description": "The end date"
    }
  },
  "required": [
    "PCID"
  ]
}

paystack_customers_subscription_manage_email

Send Update Subscription Link Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	Subscription code

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "Subscription code"
    }
  },
  "required": [
    "PCID",
    "code"
  ]
}

paystack_customers_subscription_manage_link

Generate Update Subscription Link Parameters:

Parameter	Type	Required	Default	Description
`code`	string	Yes	—	Subscription code

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "Subscription code"
    }
  },
  "required": [
    "PCID",
    "code"
  ]
}

​Tools

​paystack_customers_customer_create

​paystack_customers_customer_deactivate_authorization

​paystack_customers_customer_direct_debit_activation_charge

​paystack_customers_customer_fetch

​paystack_customers_customer_fetch_mandate_authorizations

​paystack_customers_customer_initialize_authorization

​paystack_customers_customer_initialize_direct_debit

​paystack_customers_customer_list

​paystack_customers_customer_risk_action

​paystack_customers_customer_update

​paystack_customers_customer_validate

​paystack_customers_customer_verify_authorization

​paystack_customers_dedicated_account_add_split

​paystack_customers_dedicated_account_assign

​paystack_customers_dedicated_account_available_providers

​paystack_customers_dedicated_account_create

​paystack_customers_dedicated_account_deactivate

​paystack_customers_dedicated_account_fetch

​paystack_customers_dedicated_account_list

​paystack_customers_dedicated_account_remove_split

​paystack_customers_dedicated_account_requery

​paystack_customers_directdebit_list_mandate_authorizations

​paystack_customers_directdebit_trigger_activation_charge

​paystack_customers_plan_create

​paystack_customers_plan_fetch

​paystack_customers_plan_list

​paystack_customers_plan_update

​paystack_customers_subaccount_create

​paystack_customers_subaccount_fetch

​paystack_customers_subaccount_list

​paystack_customers_subaccount_update

​paystack_customers_subscription_create

​paystack_customers_subscription_disable

​paystack_customers_subscription_enable

​paystack_customers_subscription_fetch

​paystack_customers_subscription_list

​paystack_customers_subscription_manage_email

​paystack_customers_subscription_manage_link

Tools

paystack_customers_customer_create

paystack_customers_customer_deactivate_authorization

paystack_customers_customer_direct_debit_activation_charge

paystack_customers_customer_fetch

paystack_customers_customer_fetch_mandate_authorizations

paystack_customers_customer_initialize_authorization

paystack_customers_customer_initialize_direct_debit

paystack_customers_customer_list

paystack_customers_customer_risk_action

paystack_customers_customer_update

paystack_customers_customer_validate

paystack_customers_customer_verify_authorization

paystack_customers_dedicated_account_add_split

paystack_customers_dedicated_account_assign

paystack_customers_dedicated_account_available_providers

paystack_customers_dedicated_account_create

paystack_customers_dedicated_account_deactivate

paystack_customers_dedicated_account_fetch

paystack_customers_dedicated_account_list

paystack_customers_dedicated_account_remove_split

paystack_customers_dedicated_account_requery

paystack_customers_directdebit_list_mandate_authorizations

paystack_customers_directdebit_trigger_activation_charge

paystack_customers_plan_create

paystack_customers_plan_fetch

paystack_customers_plan_list

paystack_customers_plan_update

paystack_customers_subaccount_create

paystack_customers_subaccount_fetch

paystack_customers_subaccount_list

paystack_customers_subaccount_update

paystack_customers_subscription_create

paystack_customers_subscription_disable

paystack_customers_subscription_enable

paystack_customers_subscription_fetch

paystack_customers_subscription_list

paystack_customers_subscription_manage_email

paystack_customers_subscription_manage_link