#!/usr/bin/env node

export default {

subaccount: [

{

api: 'update',

endpoint: 'https://api.paystack.co/subaccount',

method: 'PUT',

params: [],

description: null,

},

{

api: 'fetch',

endpoint: 'https://api.paystack.co/subaccount/{ID}',

method: 'GET',

params: [],

description: null,

},

{

api: 'list',

endpoint: 'https://api.paystack.co/subaccount',

method: 'GET',

params: [

{

parameter: 'perPage',

required: false,

type: 'String',

},

{

parameter: 'page',

required: false,

type: 'Number',

},

],

description:

'**Query Params**\n- **perPage** - Specify how many records you want to retrieve per page\n- **page** - Specify exactly what page you want to retrieve',

},

{

api: 'create',

endpoint: 'https://api.paystack.co/subaccount',

method: 'POST',

params: [

{

parameter: 'business_name',

required: true,

type: 'String',

},

{

parameter: 'settlement_bank',

required: true,

type: 'String',

},

{

parameter: 'account_number',

required: true,

type: 'String',

},

{

parameter: 'percentage_charge',

required: true,

type: 'String',

},

{

parameter: 'primary_contact_email',

required: false,

type: 'String',

},

{

parameter: 'primary_contact_name',

required: false,

type: 'String',

},

{

parameter: 'primary_contact_phone',

required: false,

type: 'String',

},

{

parameter: 'metadata',

required: false,

type: 'String',

},

{

parameter: 'settlement_schedule',

required: false,

type: 'String',

},

{

parameter:

'eceive payments for the created subaccount by providing their code when doing a transaction. More details here: [Split Payments Overview](https://developers.paystack.co/v1.0/docs/splitpaymentsoverview',

required: false,

type: 'String',

},

],

description:

'**Body Params**\n- **business_name** (_required_) - Name of business for subaccount\n- **settlement_bank** (_required_) - Name of Bank (see list of accepted names by calling [List Banks](https://developers.paystack.co/v1.0/docs/list-banks)\n- **account_number** (_required_) - NUBAN Bank Account Number\n- **percentage_charge** (_required_) - What is the default percentage charged when receiving on behalf of this subaccount?\n- **primary_contact_email** - A contact email for the subaccount\n- **primary_contact_name** - A name for the contact person for this subaccount\n- **primary_contact_phone** - A phone number to call for this subaccount\n- **metadata** - Stringified JSON object\n- **settlement_schedule** - Any of `auto`, `weekly`, `monthly`, `manual`. Auto means payout is T+1 and manual means payout to the subaccount should only be made when requested.\n\nReceive payments for the created subaccount by providing their code when doing a transaction. More details here: [Split Payments Overview](https://developers.paystack.co/v1.0/docs/split-payments-overview)',

},

],

page: [

{

api: 'update',

endpoint: 'https://api.paystack.co/page/',

method: 'PUT',

params: [

{

parameter: 'name',

required: false,

type: 'String',

},

{

parameter: 'description',

required: false,

type: 'String',

},

{

parameter: 'amount',

required: false,

type: 'Number',

},

{

parameter: 'active',

required: false,

type: 'String',

},

],

description:

'**Body Params**\n- **name** - Name of page\n- **description** - Short description of page\n- **amount** - Amount to be charged in kobo. Will override the amount for existing subscriptions.\n- **active** - Set to false to deactivate page url.',

},

{

api: 'fetch',

endpoint: 'https://api.paystack.co/page/id_or_plan_code',

method: 'GET',

params: [],

description: null,

},

{

api: 'list',

endpoint: 'https://api.paystack.co/page',

method: 'GET',

params: [

{

parameter: 'perPage',

required: false,

type: 'String',

},

{

parameter: 'page',

required: false,

type: 'Number',

},

{

parameter: 'interval',

required: false,

type: 'String',

},

{

parameter: 'amount',

required: false,

type: 'Number',

},

],

description:

'**Query Params**\n- **perPage** - Specify how many records you want to retrieve per page\n- **page** - Specify exactly what page you want to retrieve\n- **interval** - Filter list by plans with specified interval\n- **amount** - Filter list by plans with specified amount (in kobo)',

},

{

api: 'check',

endpoint: 'https://api.paystack.co/page/check_slug_availability/slug',

method: 'GET',

params: [

{

parameter: 'slug',

required: true,

type: 'String',

},

],

description:

'**Path Params**\n- **slug** (_required_) - URL slug to be confirmed',

},

{

api: 'create',

endpoint: 'https://api.paystack.co/page',

method: 'POST',

params: [

{

parameter: 'name',

required: true,

type: 'String',

},

{

parameter: 'description',

required: false,

type: 'String',

},

{

parameter: 'amount',

required: false,

type: 'Number',

},

{

parameter: 'slug',

required: false,

type: 'String',

},

{

parameter: 'redirect_url',

required: false,

type: 'String',

},

{

parameter: 'send_invoices',

required: false,

type: 'String',

},

{

parameter: 'custom_fields',

required: false,

type: 'String',

},

{

parameter:

'end pages created to your customers by giving out a link in this format https://paystack.com/pay/:slug. For instance, a valid link for the page above would be https://paystack.com/pay/5nApBwZkv',

required: false,

type: 'String',

},

],

description:

"**Body Params**\n- **name** (_required_) - Name of page\n- **description** - Short description of page\n- **amount** - Default amount you want to accept using this page. If none is set, customer is free to provide any amount of their choice. The latter scenario is useful for accepting donations\n- **slug** - URL slug you would like to be associated with this page. Page will be accessible at https://paystack.com/pay/[slug]\n- **redirect_url** - If you would like Paystack to redirect someplace upon successful payment, specify the URL here.\n- **send_invoices** - Set to false if you don't want invoices to be sent to your customers\n- **custom_fields** - If you would like to accept custom fields, specify them here. See sample code for details.\n\nSend pages created to your customers by giving out a link in this format https://paystack.com/pay/:slug. For instance, a valid link for the page above would be https://paystack.com/pay/5nApBwZkvY",

},

],

transfer: [

{

api: 'list',

endpoint: 'https://api.paystack.co/transfer',

method: 'GET',

params: [

{

parameter: 'perPage',

required: false,

type: 'String',

},

{

parameter: 'page',

required: false,

type: 'Number',

},

],

description:

'**Query Params**\n- **perPage** - Specify how many records you want to retrieve per page\n- **page** - Specify exactly what page you want to retrieve',

},

{

api: 'finalize',

endpoint: 'https://api.paystack.co/transfer/finalize_transfer',

method: 'POST',

params: [

{

parameter: 'transfer_code',

required: true,

type: 'String',

},

{

parameter: 'otp',

required: true,

type: 'String',

},

],

description:

'**Body Params**\n- **transfer_code** (_required_) - Transfer code\n- **otp** (_required_) - OTP sent to business phone to verify transfer.',

},

{

api: 'initiate',

endpoint: 'https://api.paystack.co/transfer',

method: 'POST',

params: [

{

parameter: 'Body Params',

required: false,

type: 'String',

},

{

parameter: 'source',

required: true,

type: 'String',

},

{

parameter: 'amount',

required: false,

type: 'Number',

},

{

parameter: 'currency',

required: false,

type: 'String',

},

{

parameter: 'reason',

required: false,

type: 'String',

},

{

parameter: 'recipient',

required: true,

type: 'String',

},

{

parameter: 'reference',

required: false,

type: 'String',

},

],

description:

'Status of transfer object returned will be ‘pending’ if OTP is disabled. In the event that an OTP is required, status will read ‘otp’.\n\n**Body Params**\n- **source** (_required_) - Where should we transfer from? Only balance for now\n- **amount** - Amount to transfer in kobo\n- **currency** - NGN\n- **reason**\n- **recipient** (_required_) - Code for transfer recipient\n- **reference** - If specified, the field should be a unique identifier (in lowercase) for the object. Only `-` `,` `_` and alphanumeric characters allowed.',

},

{

api: 'verify',

endpoint: 'https://api.paystack.co/transfer/{reference}',

method: 'GET',

params: [

{

parameter: 'perPage',

required: false,

type: 'String',

},

{

parameter: 'reference',

required: true,

type: 'String',

},

{

parameter: 'page',

required: false,

type: 'Number',

},

],

description:

'**Query Params**\n- **perPage** - Specify how many records you want to retrieve per page\n- **page** - Specify exactly what page you want to retrieve',

},

{

api: 'disable',

endpoint: 'https://api.paystack.co/transfer/disable_otp',

method: 'POST',

params: [

{

parameter:

'n the event that you want to be able to complete transfers programmatically without use of OTPs, this endpoint helps disable that….with an OTP. No arguments required. An OTP is sent to you on your business phone',

required: true,

type: 'String',

},

],

description:

'In the event that you want to be able to complete transfers programmatically without use of OTPs, this endpoint helps disable that….with an OTP. No arguments required. You will get an OTP.\n\nIn the event that you want to be able to complete transfers programmatically without use of OTPs, this endpoint helps disable that….with an OTP. No arguments required. An OTP is sent to you on your business phone.',

},

{

api: 'enable',

endpoint: 'https://api.paystack.co/transfer/enable_otp',

method: 'POST',

params: [],

description:

'In the event that a customer wants to stop being able to complete transfers programmatically, this endpoint helps turn OTP requirement back on. No arguments required.',

},

{

api: 'initiate',

endpoint: 'https://api.paystack.co/transfer/bulk',

method: 'POST',

params: [

{

parameter: 'Body Params',

required: false,

type: 'String',

},

{

parameter: '(no name)',

required: false,

type: 'String',

},

{

parameter:

'tatus of transfer object returned will be ‘pending’ if OTP is disabled. In the event that an OTP is required, status will read ‘otp’',

required: true,

type: 'String',

},

],

description:

'You need to disable the Transfers OTP requirement to use this endpoint.\n\n**Body Params**\n- **(no name)**\n\nStatus of transfer object returned will be ‘pending’ if OTP is disabled. In the event that an OTP is required, status will read ‘otp’.',

},

{

api: 'finalize',

endpoint: 'https://api.paystack.co/transfer/disable_otp_finalize',

method: 'POST',

params: [

{

parameter: 'otp',

required: true,

type: 'String',

},

],

description:

'**Body Params**\n- **otp** (_required_) - OTP sent to business phone to verify disabling OTP requirement\n\n',

},

{

api: 'fetch',

endpoint: 'https://api.paystack.co/transfer/id',

method: 'GET',

params: [

{

parameter: 'id_or_code',

required: true,

type: 'String',

},

],

description:

'**Path Params**\n- **id_or_code** (_required_) - An ID or code for the transfer whose details you want to retrieve.',

},

{

api: 'list',

endpoint: 'https://api.paystack.co/transfer/id_or_code',

method: 'GET',

params: [

{

parameter: 'perPage',

required: false,

type: 'String',

},

{

parameter: 'page',

required: false,

type: 'Number',

},

],

description:

'This lists all bulk charge batches created by the integration. Statuses can be `active`, `paused`, or `complete`.\n\n**Query Params**\n- **perPage** - Specify how many records you want to retrieve per page\n- **page** - Specify exactly what page you want to retrieve',

},

{

api: 'resend',

endpoint: 'https://api.paystack.co/transfer/resend_otp',

method: 'POST',

params: [

{

parameter: 'Body Params',

required: false,

type: 'String',

},

{

parameter: 'transfer_code',

required: true,

type: 'String',

},

{

parameter: 'reason',

required: true,

type: 'String',

},

],

description:

'Creates a new recipient. An duplicate account number will lead to the retrieval of the existing record.\n\n**Body Params**\n- **transfer_code** (_required_) - Transfer code\n- **reason** (_required_) - either `resend_otp` or `transfer`',

},

],

paymentrequest: [

{

api: 'create',

endpoint: 'https://api.paystack.co/paymentrequest',

method: 'POST',

params: [

{

parameter: 'customer',

required: true,

type: 'String',

},

{

parameter: 'due_date',

required: true,

type: 'String',

},

{

parameter: 'amount',

required: true,

type: 'Number',

},

{

parameter: 'description',

required: false,

type: 'String',

},

{

parameter: 'line_items',

required: false,

type: 'String',

},

{

parameter: 'tax',

required: false,

type: 'String',

},

{

parameter: 'currency',

required: false,

type: 'String',

},

{

parameter: 'send_notification',

required: false,

type: 'String',

},

{

parameter: 'draft',

required: false,

type: 'String',

},

{

parameter: 'send_notification',

required: false,

type: 'String',

},

{

parameter: 'has_invoice',

required: false,

type: 'String',

},

{

parameter: 'invoice_number',

required: false,

type: 'String',

},

],

description:

'**Body Params**\n- **customer** (_required_) - Customer ID or code\n- **due_date** (_required_) - ISO 8601 representation of request due date\n- **amount** (_required_) - Invoice amount. Only useful if line items and tax values are ignored. endpoint will throw a friendly warning if neither is available.\n- **description**\n- **line_items** - Array of line items in the format `[{"name":"item 1", "amount":2000}]`\n- **tax** - Array of taxes to be charged in the format `[{"name":"VAT", "amount":2000}]`\n- **currency** - Defaults to Naira\n- **send_notification** - Indicates whether Paystack sends an email notification to customer. Defaults to `true`.\n- **draft** - Indicate if request should be saved as draft. Defaults to `false` and overrides send_notification.\n- **send_notification** - Indicates whether Paystack sends an email notification to customer. Defaults to `true`.\n- **has_invoice** - Set to `true` to create a draft invoice (adds an auto incrementing invoice number if none is provided) even if there are no `line_items` or `tax` passed.\n- **invoice_number** - Numeric value of invoice. Invoice will start from 1 and auto increment from there. This field is to help override whatever value Paystack decides. Auto increment for subsequent invoices continue from this point.',

},

{

api: 'finalize',

endpoint: 'https://api.paystack.co/paymentrequest/finalize/ID_OR_CODE',

method: 'POST',

params: [

{

parameter: 'Body Params',

required: false,

type: 'String',

},

{

parameter: 'send_notification',

required: false,

type: 'String',

},

],

description:

'Publishes invoice that is draft by sending customer the invoice via email\n\n**Body Params**\n- **send_notification** - Indicates whether Paystack sends an email notification to customer. Defaults to `true`',

},

{

api: 'send',

endpoint: 'https://api.paystack.co/paymentrequest/notify/ID_OR_CODE',

method: 'POST',

params: [

{

parameter: 'id',

required: false,

type: 'String',

},

],

description:

'**Path Params**\n- **id** - Invoice code for which you want to send a notification for',

},

{

api: 'list',

endpoint: 'https://api.paystack.co/paymentrequest',

method: 'GET',

params: [

{

parameter: 'customer',

required: false,

type: 'String',

},

{

parameter: 'status',

required: false,

type: 'String',

},

{

parameter: 'currency',

required: false,

type: 'String',

},

{

parameter: 'paid',

required: false,

type: 'String',

},

{

parameter: 'include_archive',

required: false,

type: 'String',

},

{

parameter: 'payment_request',

required: false,

type: 'String',

},

],

description:

"**Query Params**\n- **customer** - Specify an ID for the customer whose requests you want to retrieve\n- **status** - Filter requests by status ('failed', 'success', 'abandoned')\n- **currency** - Filter requests sent in a particular currency.\n- **paid** - Filter requests that have been paid for \n- **include_archive** - Includes archived requests in the response\n- **payment_request** - Filter specific invoice by passing invoice code",

},

{

api: 'view',

endpoint: 'https://api.paystack.co/paymentrequest/REQUEST_ID_OR_CODE',

method: 'GET',

params: [

{

parameter: 'id',

required: true,

type: 'String',

},

],

description:

'**Path Params**\n- **id** _(required)_ - An ID for the Invoice',

},

{

api: 'invoice',

endpoint: 'https://api.paystack.co/paymentrequest/totals',

method: 'GET',

params: [],

description: null,

},

{

api: 'update',

endpoint: 'https://api.paystack.co/paymentrequest/ID_OR_CODE',

method: 'PUT',

params: [

{

parameter: 'description',

required: false,

type: 'String',

},

{

parameter: 'amount',

required: false,

type: 'Number',

},

{

parameter: 'line_item',

required: false,

type: 'String',

},

{

parameter: 'tax',

required: false,

type: 'String',

},

{

parameter: 'due_date',

required: false,

type: 'String',

},

{

parameter: 'metadata',

required: false,

type: 'String',

},

{

parameter: 'send_notification',

required: false,

type: 'String',

},

{

parameter: 'currency',

required: false,

type: 'String',

},

{

parameter: 'customer',

required: false,

type: 'String',

},

],

description:

'**Body Params**\n- **description**\n- **amount**\n- **line_item**\n- **tax**\n- **due_date**\n- **metadata**\n- **send_notification**\n- **currency** - only works in draft mode\n- **customer** - only works in draft mode',

},

{

api: 'verify',

endpoint: 'https://api.paystack.co/paymentrequest/verify/{ID}',

method: 'GET',

params: [

{

parameter: 'ID',

required: false,

type: 'String',

},

{

parameter:

'ote that a key is added called `pending_amount` when you fetch an invoice. This is because when paying for an invoice, you can choose to pay part but not all. Whenever a successful transaction is made, the key updates to reveal what’s left of the invoice to pay',

required: false,

type: 'String',

},

],

description:

'**Path Params**\n- **ID** - The invoice code for the Payment Request to be verified\n\nNote that a key is added called `pending_amount` when you fetch an invoice. This is because when paying for an invoice, you can choose to pay part but not all. Whenever a successful transaction is made, the key updates to reveal what’s left of the invoice to pay.',

},

],

transferrecipient: [

{

api: 'create',

endpoint: 'https://api.paystack.co/transferrecipient',

method: 'POST',

params: [

{

parameter: 'Body Params',

required: false,

type: 'String',

},

{

parameter: 'type',

required: true,

type: 'String',

},

{

parameter: 'name',

required: true,

type: 'String',

},

{

parameter: 'metadata',

required: false,

type: 'String',

},

{

parameter: 'bank_code',

required: true,

type: 'String',

},

{

parameter: 'account_number',

required: true,

type: 'String',

},

{

parameter: 'currency',

required: false,

type: 'String',

},

{

parameter: 'description',

required: false,

type: 'String',

},

],

description:

'Creates a new recipient. An duplicate account number will lead to the retrieval of the existing record.\n\n**Body Params**\n- **type** (_required_) - Recipient Type (Only nuban at this time)\n- **name** (_required_) - A name for the recipient\n- **metadata** - Store additional information about your recipient in a structured format. JSON\n- **bank_code** (_required_) - Required if type is nuban. You can find a list of bank codes at [api.paystack.co/bank](https://api.paystack.co/bank)\n- **account_number** (_required_) - Required if type is `nuban`\n- **currency** - Currency for the account receiving the transfer.\n- **description**',

},

{

api: 'delete',

endpoint: 'https://api.paystack.co/transferrecipient',

method: 'DELETE',

params: [],

description: null,

},

{

api: 'list',

endpoint: 'https://api.paystack.co/transferrecipient',

method: 'GET',

params: [

{

parameter: 'perPage',

required: false,

type: 'String',

},

{

parameter: 'page',

required: false,

type: 'Number',

},

],

description:

'**Query Params**\n- **perPage** - Specify how many records you want to retrieve per page\n- **page** - Specify exactly what page you want to retrieve',

},

{

api: 'update',

endpoint: '{recipient_code_or_id}',

method: 'PUT',

params: [],

description: null,

},

],

subscription: [

{

api: 'disable',

endpoint: 'https://api.paystack.co/subscription/disable',

method: 'POST',

params: [

{

parameter: 'code',

required: true,

type: 'String',

},

{

parameter: 'token',

required: true,

type: 'String',

},

],

description:

'**Body Params**\n- **code** (_required_) - Subscription code\n- **token** (_required_) - Email token',

},

{

api: 'fetch',

endpoint: ':id_or_subscription_code',

method: 'GET',

params: [],

description: null,

},

{

api: 'create',

endpoint: 'https://api.paystack.co/subscription',

method: 'POST',

params: [

{

parameter: 'customer',

required: true,

type: 'String',

},

{

parameter: 'plan',

required: true,

type: 'String',

},

{

parameter: 'authorization',

required: false,

type: 'String',

},

{

parameter: 'start_date',

required: false,

type: 'String',

},

{

parameter:

'ote the `email_token` attribute for the subscription object. We create one on each subscription so customers can cancel their subscriptions from within the invoices sent to their mailboxes. Since they are not authorized, the email tokens are what we use to authenticate the requests over the API',

required: false,

type: 'String',

},

],

description:

"**Body Params**\n- **customer** (_required_) - Customer's email address or customer code\n- **plan** (_required_) - Plan code\n- **authorization** - 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\n- **start_date** - Set the date for the first debit. (ISO 8601 format)\n\nNote the `email_token` attribute for the subscription object. We create one on each subscription so customers can cancel their subscriptions from within the invoices sent to their mailboxes. Since they are not authorized, the email tokens are what we use to authenticate the requests over the API.",

},

{

api: 'list',

endpoint: 'https://api.paystack.co/subscription',

method: 'GET',

params: [

{

parameter: 'perPage',

required: false,

type: 'String',

},

{

parameter: 'page',

required: false,

type: 'Number',

},

{

parameter: 'customer',

required: false,

type: 'String',

},

{

parameter: 'plan',

required: false,

type: 'String',

},

],

description:

'**Query Params**\n- **perPage** - Specify how many records you want to retrieve per page\n- **page** - Specify exactly what page you want to retrieve\n- **customer** - Filter by Customer ID\n- **plan** - Filter by Plan ID',

},

{

api: 'enable',

endpoint: 'https://api.paystack.co/subscription/enable',

method: 'POST',

params: [

{

parameter: 'code',

required: true,

type: 'String',

},

{

parameter: 'token',

required: true,

type: 'String',

},

],

description:

'**Body Params**\n- **code** (_required_) - Subscription code\n- **token** (_required_) - Email token',

},

],

bulkcharge: [

{

api: 'fetch',

endpoint: 'https://api.paystack.co/bulkcharge/id_or_code',

method: 'GET',

params: [

{

parameter: 'Path Params',

required: false,

type: 'String',

},

{

parameter: 'id_or_code',

required: true,

type: 'String',

},

],

description:

'This endpoint retrieves a specific batch code. It also returns useful information on its progress by way of the `total_charges` and `pending_charges` attributes.\n\n**Path Params**\n- **id_or_code** (_required_) - An ID or code for the transfer whose details you want to retrieve.',

},

{

api: 'fetch',

endpoint: 'https://api.paystack.co/bulkcharge/id_or_code/charges',

method: 'GET',

params: [

{

parameter: 'Path Params',

required: false,

type: 'String',

},

{

parameter: 'id_or_code',

required: true,

type: 'String',

},

{

parameter: 'status',

required: false,

type: 'String',

},

{

parameter: 'perPage',

required: false,

type: 'String',

},

{

parameter: 'page',

required: false,

type: 'Number',

},

],

description:

'This endpoint retrieves the charges associated with a specified batch code. Pagination parameters are available. You can also filter by status. Charge statuses can be `pending`, `success` or `failed`.\n\n**Path Params**\n- **id_or_code** (_required_) - An ID or code for the batch whose charges you want to retrieve.\n\n**Query Params**\n- **status** - `pending`, `success` or `failed`\n- **perPage**\n- **page**\n',

},

{

api: 'initiate',

endpoint: 'https://api.paystack.co/bulkcharge',

method: 'POST',

params: [

{

parameter: 'Body Params',

required: false,

type: 'String',

},

{

parameter: '(no_name)',

required: false,

type: 'String',

},

],

description:

'Send an array of objects with authorization codes and amount in kobo so we can process transactions as a batch.\n\n**Body Params**\n- **(no_name)**',

},

{

api: 'resume',

endpoint: 'https://api.paystack.co/bulkcharge/resume/batch_code',

method: 'GET',

params: [

{

parameter: 'Path Params',

required: false,

type: 'String',

},

{

parameter: 'batch_code',

required: true,

type: 'String',

},

],

description:

'Use this endpoint to pause processing a batch\n\n**Path Params**\n- **batch_code** (_required_)',

},

{

api: 'pause',

endpoint: 'https://api.paystack.co/bulkcharge/pause/batch_code',

method: 'GET',

params: [

{

parameter: 'Path Params',

required: false,

type: 'String',

},

{

parameter: 'batch_code',

required: true,

type: 'String',