> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # paystack-payments > Paystack Payments - transactions, charges, refunds, disputes, and payment requests **Server path:** `/paystack-payments` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------- | -------------------------- | | [`paystack_payments_charge_check`](#paystack_payments_charge_check) | Check pending charge | | [`paystack_payments_charge_create`](#paystack_payments_charge_create) | Create Charge | | [`paystack_payments_charge_submit_address`](#paystack_payments_charge_submit_address) | Submit Address | | [`paystack_payments_charge_submit_birthday`](#paystack_payments_charge_submit_birthday) | Submit Birthday | | [`paystack_payments_charge_submit_otp`](#paystack_payments_charge_submit_otp) | Submit OTP | | [`paystack_payments_charge_submit_phone`](#paystack_payments_charge_submit_phone) | Submit Phone | | [`paystack_payments_charge_submit_pin`](#paystack_payments_charge_submit_pin) | Submit PIN | | [`paystack_payments_dispute_download`](#paystack_payments_dispute_download) | Export Disputes | | [`paystack_payments_dispute_evidence`](#paystack_payments_dispute_evidence) | Add Evidence | | [`paystack_payments_dispute_fetch`](#paystack_payments_dispute_fetch) | Fetch Dispute | | [`paystack_payments_dispute_list`](#paystack_payments_dispute_list) | List Disputes | | [`paystack_payments_dispute_resolve`](#paystack_payments_dispute_resolve) | Resolve Dispute | | [`paystack_payments_dispute_transaction`](#paystack_payments_dispute_transaction) | List Transaction Disputes | | [`paystack_payments_dispute_update`](#paystack_payments_dispute_update) | Update Dispute | | [`paystack_payments_dispute_upload_url`](#paystack_payments_dispute_upload_url) | Fetch Upload URL | | [`paystack_payments_payment_request_archive`](#paystack_payments_payment_request_archive) | Archive Payment Request | | [`paystack_payments_payment_request_create`](#paystack_payments_payment_request_create) | Create Payment Request | | [`paystack_payments_payment_request_fetch`](#paystack_payments_payment_request_fetch) | Fetch Payment Request | | [`paystack_payments_payment_request_finalize`](#paystack_payments_payment_request_finalize) | Finalize Payment Request | | [`paystack_payments_payment_request_list`](#paystack_payments_payment_request_list) | List Payment Request | | [`paystack_payments_payment_request_notify`](#paystack_payments_payment_request_notify) | Send Notification | | [`paystack_payments_payment_request_totals`](#paystack_payments_payment_request_totals) | Payment Request Total | | [`paystack_payments_payment_request_update`](#paystack_payments_payment_request_update) | Update Payment Request | | [`paystack_payments_payment_request_verify`](#paystack_payments_payment_request_verify) | Verify Payment Request | | [`paystack_payments_refund_create`](#paystack_payments_refund_create) | Create Refund | | [`paystack_payments_refund_fetch`](#paystack_payments_refund_fetch) | Fetch Refund | | [`paystack_payments_refund_list`](#paystack_payments_refund_list) | List Refunds | | [`paystack_payments_refund_retry`](#paystack_payments_refund_retry) | Retry Refund | | [`paystack_payments_transaction_charge_authorization`](#paystack_payments_transaction_charge_authorization) | Charge Authorization | | [`paystack_payments_transaction_export`](#paystack_payments_transaction_export) | Export Transactions | | [`paystack_payments_transaction_fetch`](#paystack_payments_transaction_fetch) | Fetch Transaction | | [`paystack_payments_transaction_initialize`](#paystack_payments_transaction_initialize) | Initialize Transaction | | [`paystack_payments_transaction_list`](#paystack_payments_transaction_list) | List Transactions | | [`paystack_payments_transaction_partial_debit`](#paystack_payments_transaction_partial_debit) | Partial Debit | | [`paystack_payments_transaction_timeline`](#paystack_payments_transaction_timeline) | Fetch Transaction Timeline | | [`paystack_payments_transaction_totals`](#paystack_payments_transaction_totals) | Transaction Totals | | [`paystack_payments_transaction_verify`](#paystack_payments_transaction_verify) | Verify Transaction | *** ## paystack\_payments\_charge\_check Check pending charge **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------- | | `reference` | string | Yes | — | The reference of the ongoing transaction | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "reference": { "type": "string", "description": "The reference of the ongoing transaction" } }, "required": [ "PCID", "reference" ] } ``` *** ## paystack\_payments\_charge\_create Create Charge **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 | | `authorization_code` | string | No | — | An authorization code to charge. | | `bank` | object | No | — | The bank object if charging a bank account | | `birthday` | string | No | — | The customer's birthday in the format YYYY-MM-DD e.g 2017-05-16 | | `device_id` | string | No | — | This is the unique identifier of the device a user uses in making payment. Only -, .\`, = and alphanumeric characters are allowed. | | `eft` | object | No | — | Details of the EFT provider | | `email` | string | Yes | — | Customer's email address | | `metadata` | object | No | — | JSON object of custom data | | `mobile_money` | object | No | — | Details of the mobile service provider | | `pin` | string | No | — | 4-digit PIN (send with a non-reusable authorization code) | | `reference` | string | No | — | Unique transaction reference. Only -, .\`, = and alphanumeric characters allowed. | | `ussd` | object | No | — | The USSD code for the provider to charge | ```json theme={null} { "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" }, "authorization_code": { "type": "string", "description": "An authorization code to charge." }, "bank": { "type": "object", "description": "The bank object if charging a bank account", "properties": { "code": { "type": "string", "description": "Customer's bank code" }, "account_number": { "type": "string", "description": "Customer's account number" } } }, "birthday": { "type": "string", "description": "The customer's birthday in the format YYYY-MM-DD e.g 2017-05-16" }, "device_id": { "type": "string", "description": "This is the unique identifier of the device a user uses in making payment. Only -, .`, = and alphanumeric characters are allowed." }, "eft": { "type": "object", "description": "Details of the EFT provider", "properties": { "provider": { "type": "string", "description": "The EFT provider" } } }, "email": { "type": "string", "description": "Customer's email address" }, "metadata": { "type": "object", "description": "JSON object of custom data" }, "mobile_money": { "type": "object", "description": "Details of the mobile service provider", "properties": { "phone": { "type": "string", "description": "Customer's phone number" }, "provider": { "type": "string", "description": "The telco provider of customer's phone number. This can be fetched from the List Bank endpoint" } } }, "pin": { "type": "string", "description": "4-digit PIN (send with a non-reusable authorization code)" }, "reference": { "type": "string", "description": "Unique transaction reference. Only -, .`, = and alphanumeric characters allowed." }, "ussd": { "type": "object", "description": "The USSD code for the provider to charge", "properties": { "type": { "type": "string", "description": "The three-digit USSD code.", "enum": [ "737", "919", "822", "966" ] } } } }, "required": [ "PCID", "amount", "email" ] } ``` *** ## paystack\_payments\_charge\_submit\_address Submit Address **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------- | | `address` | string | Yes | — | Customer's address | | `city` | string | Yes | — | Customer's city | | `reference` | string | Yes | — | The reference of the ongoing transaction | | `state` | string | Yes | — | Customer's state | | `zip_code` | string | Yes | — | Customer's zipcode | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "address": { "type": "string", "description": "Customer's address" }, "city": { "type": "string", "description": "Customer's city" }, "reference": { "type": "string", "description": "The reference of the ongoing transaction" }, "state": { "type": "string", "description": "Customer's state" }, "zip_code": { "type": "string", "description": "Customer's zipcode" } }, "required": [ "PCID", "address", "city", "reference", "state", "zip_code" ] } ``` *** ## paystack\_payments\_charge\_submit\_birthday Submit Birthday **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------------------------------- | | `birthday` | string | Yes | — | Customer's birthday in the format YYYY-MM-DD e.g 2016-09-21 | | `reference` | string | Yes | — | The reference of the ongoing transaction | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "birthday": { "type": "string", "description": "Customer's birthday in the format YYYY-MM-DD e.g 2016-09-21" }, "reference": { "type": "string", "description": "The reference of the ongoing transaction" } }, "required": [ "PCID", "birthday", "reference" ] } ``` *** ## paystack\_payments\_charge\_submit\_otp Submit OTP **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------- | | `otp` | string | Yes | — | Customer's OTP for ongoing transaction | | `reference` | string | Yes | — | The reference of the ongoing transaction | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "otp": { "type": "string", "description": "Customer's OTP for ongoing transaction" }, "reference": { "type": "string", "description": "The reference of the ongoing transaction" } }, "required": [ "PCID", "otp", "reference" ] } ``` *** ## paystack\_payments\_charge\_submit\_phone Submit Phone **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------- | | `phone` | string | Yes | — | Customer's mobile number | | `reference` | string | Yes | — | The reference of the ongoing transaction | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "phone": { "type": "string", "description": "Customer's mobile number" }, "reference": { "type": "string", "description": "The reference of the ongoing transaction" } }, "required": [ "PCID", "phone", "reference" ] } ``` *** ## paystack\_payments\_charge\_submit\_pin Submit PIN **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ------------------------------------------- | | `pin` | string | Yes | — | Customer's PIN for the ongoing transaction | | `reference` | string | Yes | — | Transaction reference that requires the PIN | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pin": { "type": "string", "description": "Customer's PIN for the ongoing transaction" }, "reference": { "type": "string", "description": "Transaction reference that requires the PIN" } }, "required": [ "PCID", "pin", "reference" ] } ``` *** ## paystack\_payments\_dispute\_download Export Disputes **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------------------------------- | | `perPage` | integer | No | — | Number of records to fetch per page | | `page` | integer | No | — | The section to retrieve | | `status` | string | No | — | The status value | | `from` | string | No | — | The start date | | `to` | string | No | — | The end date | ```json theme={null} { "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" }, "status": { "type": "string", "description": "The status value", "enum": [ "awaiting-merchant-feedback", "awaiting-bank-feedback", "pending", "resolved" ] }, "from": { "type": "string", "description": "The start date" }, "to": { "type": "string", "description": "The end date" } }, "required": [ "PCID" ] } ``` *** ## paystack\_payments\_dispute\_evidence Add Evidence **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | ----------------------------------------------------- | | `id` | integer | Yes | — | The unique identifier of the dispute | | `customer_email` | string | Yes | — | Customer email | | `customer_name` | string | Yes | — | Customer name | | `customer_phone` | string | Yes | — | Customer mobile number | | `delivery_address` | string | No | — | Delivery address | | `delivery_date` | string | No | — | ISO 8601 representation of delivery date (YYYY-MM-DD) | | `service_details` | string | Yes | — | Details of service offered | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of the dispute" }, "customer_email": { "type": "string", "description": "Customer email" }, "customer_name": { "type": "string", "description": "Customer name" }, "customer_phone": { "type": "string", "description": "Customer mobile number" }, "delivery_address": { "type": "string", "description": "Delivery address" }, "delivery_date": { "type": "string", "description": "ISO 8601 representation of delivery date (YYYY-MM-DD)" }, "service_details": { "type": "string", "description": "Details of service offered" } }, "required": [ "PCID", "id", "customer_email", "customer_name", "customer_phone", "service_details" ] } ``` *** ## paystack\_payments\_dispute\_fetch Fetch Dispute **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------ | | `id` | integer | Yes | — | The unique identifier of the dispute | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of the dispute" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_dispute\_list List Disputes **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ----------------------------------- | | `perPage` | integer | No | — | Number of records to fetch per page | | `page` | integer | No | — | The section to retrieve | | `status` | string | No | — | Dispute status | | `transaction` | string | No | — | Transaction ID | | `from` | string | No | — | The start date | | `to` | string | No | — | The end date | ```json theme={null} { "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" }, "status": { "type": "string", "description": "Dispute status", "enum": [ "awaiting-merchant-feedback", "awaiting-bank-feedback", "pending", "resolved" ] }, "transaction": { "type": "string", "description": "Transaction ID" }, "from": { "type": "string", "description": "The start date" }, "to": { "type": "string", "description": "The end date" } }, "required": [ "PCID" ] } ``` *** ## paystack\_payments\_dispute\_resolve Resolve Dispute **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------ | | `id` | integer | Yes | — | The unique identifier of the dispute | | `evidence` | integer | No | — | Evidence Id for fraud claims | | `message` | string | Yes | — | Reason for resolving | | `refund_amount` | integer | Yes | — | The amount to refund, in the subunit of your integration currency | | `resolution` | string | Yes | — | Dispute resolution. Accepted values, merchant-accepted, declined | | `uploaded_filename` | string | Yes | — | Filename of attachment returned via response from the Dispute upload URL | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of the dispute" }, "evidence": { "type": "integer", "description": "Evidence Id for fraud claims" }, "message": { "type": "string", "description": "Reason for resolving" }, "refund_amount": { "type": "integer", "description": "The amount to refund, in the subunit of your integration currency" }, "resolution": { "type": "string", "description": "Dispute resolution. Accepted values, merchant-accepted, declined" }, "uploaded_filename": { "type": "string", "description": "Filename of attachment returned via response from the Dispute upload URL" } }, "required": [ "PCID", "id", "message", "refund_amount", "resolution", "uploaded_filename" ] } ``` *** ## paystack\_payments\_dispute\_transaction List Transaction Disputes **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------------------------- | | `id` | integer | Yes | — | The unique identifier of the transaction | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of the transaction" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_dispute\_update Update Dispute **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------ | | `id` | integer | Yes | — | The unique identifier of the dispute | | `refund_amount` | integer | Yes | — | The amount to refund, in the subunit of your currency | | `uploaded_filename` | string | No | — | Filename of attachment returned via response from the Dispute upload URL | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of the dispute" }, "refund_amount": { "type": "integer", "description": "The amount to refund, in the subunit of your currency" }, "uploaded_filename": { "type": "string", "description": "Filename of attachment returned via response from the Dispute upload URL" } }, "required": [ "PCID", "id", "refund_amount" ] } ``` *** ## paystack\_payments\_dispute\_upload\_url Fetch Upload URL **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------ | | `id` | integer | Yes | — | The unique identifier of the dispute | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of the dispute" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_payment\_request\_archive Archive Payment Request **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------- | | `id` | integer | Yes | — | The unique identifier of a previously created payment request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of a previously created payment request" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_payment\_request\_create Create Payment Request **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount` | integer | Yes | — | Payment request amount. Only useful if line items and tax values are ignored. The endpoint will throw a friendly warning if neither is available. | | `currency` | string | No | — | Specify the currency of the invoice. Allowed values are NGN, GHS, ZAR and USD. Defaults to NGN | | `customer` | string | Yes | — | Customer id or code | | `description` | string | No | — | A short description of the payment request | | `draft` | boolean | No | — | Indicate if request should be saved as draft. Defaults to false and overrides send\_notification | | `due_date` | string | No | — | ISO 8601 representation of request due date | | `has_invoice` | boolean | No | — | 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 | | `invoice_number` | integer | No | — | 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. | | `line_items` | object\[] | No | — | Array of line items | | `send_notification` | boolean | No | — | Indicates whether Paystack sends an email notification to customer. Defaults to true | | `split_code` | string | No | — | The split code of the transaction split. | | `tax` | object\[] | No | — | Array of taxes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "amount": { "type": "integer", "description": "Payment request amount. Only useful if line items and tax values are ignored. The endpoint will throw a friendly warning if neither is available." }, "currency": { "type": "string", "description": "Specify the currency of the invoice. Allowed values are NGN, GHS, ZAR and USD. Defaults to NGN" }, "customer": { "type": "string", "description": "Customer id or code" }, "description": { "type": "string", "description": "A short description of the payment request" }, "draft": { "type": "boolean", "description": "Indicate if request should be saved as draft. Defaults to false and overrides send_notification" }, "due_date": { "type": "string", "description": "ISO 8601 representation of request due date" }, "has_invoice": { "type": "boolean", "description": "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" }, "invoice_number": { "type": "integer", "description": "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." }, "line_items": { "type": "array", "items": { "type": "object" }, "description": "Array of line items" }, "send_notification": { "type": "boolean", "description": "Indicates whether Paystack sends an email notification to customer. Defaults to true" }, "split_code": { "type": "string", "description": "The split code of the transaction split." }, "tax": { "type": "array", "items": { "type": "object" }, "description": "Array of taxes" } }, "required": [ "PCID", "amount", "customer" ] } ``` *** ## paystack\_payments\_payment\_request\_fetch Fetch Payment Request **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------- | | `id` | integer | Yes | — | The unique identifier of a previously created payment request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of a previously created payment request" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_payment\_request\_finalize Finalize Payment Request **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------ | | `id` | integer | Yes | — | The unique identifier of a draft payment request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of a draft payment request" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_payment\_request\_list List Payment Request **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ----------------------------------------------------------------------------- | | `perPage` | integer | No | — | Number of records to fetch per page | | `page` | integer | No | — | The section to retrieve | | `customer` | string | No | — | Customer ID | | `status` | string | No | — | Invoice status to filter | | `currency` | string | No | — | If your integration supports more than one currency, choose the one to filter | | `from` | string | No | — | The start date | | `to` | string | No | — | The end date | ```json theme={null} { "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" }, "customer": { "type": "string", "description": "Customer ID" }, "status": { "type": "string", "description": "Invoice status to filter", "enum": [ "draft", "pending", "success", "failed" ] }, "currency": { "type": "string", "description": "If your integration supports more than one currency, choose the one to filter" }, "from": { "type": "string", "description": "The start date" }, "to": { "type": "string", "description": "The end date" } }, "required": [ "PCID" ] } ``` *** ## paystack\_payments\_payment\_request\_notify Send Notification **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------- | | `id` | integer | Yes | — | The unique identifier of a previously created payment request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of a previously created payment request" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_payment\_request\_totals Payment Request Total ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## paystack\_payments\_payment\_request\_update Update Payment Request **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The unique identifier of a previously created payment request | | `amount` | integer | No | — | Payment request amount. Only useful if line items and tax values are ignored. The endpoint will throw a friendly warning if neither is available. | | `currency` | string | No | — | Specify the currency of the invoice. Allowed values are NGN, GHS, ZAR and USD. Defaults to NGN | | `customer` | string | No | — | Customer id or code | | `description` | string | No | — | A short description of the payment request | | `draft` | boolean | No | — | Indicate if request should be saved as draft. Defaults to false and overrides send\_notification | | `due_date` | string | No | — | ISO 8601 representation of request due date | | `has_invoice` | boolean | No | — | 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 | | `invoice_number` | integer | No | — | 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. | | `line_items` | object\[] | No | — | Array of line items | | `send_notification` | boolean | No | — | Indicates whether Paystack sends an email notification to customer. Defaults to true | | `split_code` | string | No | — | The split code of the transaction split. | | `tax` | object\[] | No | — | Array of taxes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of a previously created payment request" }, "amount": { "type": "integer", "description": "Payment request amount. Only useful if line items and tax values are ignored. The endpoint will throw a friendly warning if neither is available." }, "currency": { "type": "string", "description": "Specify the currency of the invoice. Allowed values are NGN, GHS, ZAR and USD. Defaults to NGN" }, "customer": { "type": "string", "description": "Customer id or code" }, "description": { "type": "string", "description": "A short description of the payment request" }, "draft": { "type": "boolean", "description": "Indicate if request should be saved as draft. Defaults to false and overrides send_notification" }, "due_date": { "type": "string", "description": "ISO 8601 representation of request due date" }, "has_invoice": { "type": "boolean", "description": "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" }, "invoice_number": { "type": "integer", "description": "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." }, "line_items": { "type": "array", "items": { "type": "object" }, "description": "Array of line items" }, "send_notification": { "type": "boolean", "description": "Indicates whether Paystack sends an email notification to customer. Defaults to true" }, "split_code": { "type": "string", "description": "The split code of the transaction split." }, "tax": { "type": "array", "items": { "type": "object" }, "description": "Array of taxes" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_payment\_request\_verify Verify Payment Request **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------- | | `id` | integer | Yes | — | The unique identifier of a previously created payment request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The unique identifier of a previously created payment request" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_refund\_create Create Refund **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------- | | `amount` | integer | No | — | Amount to be refunded to the customer. It cannot be more than the original transaction amount | | `currency` | string | No | — | Three-letter ISO currency | | `customer_note` | string | No | — | Customer reason | | `merchant_note` | string | No | — | Merchant reason | | `transaction` | string | Yes | — | The reference of a previosuly completed transaction | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "amount": { "type": "integer", "description": "Amount to be refunded to the customer. It cannot be more than the original transaction amount" }, "currency": { "type": "string", "description": "Three-letter ISO currency", "enum": [ "GHS", "KES", "NGN", "USD", "ZAR" ] }, "customer_note": { "type": "string", "description": "Customer reason" }, "merchant_note": { "type": "string", "description": "Merchant reason" }, "transaction": { "type": "string", "description": "The reference of a previosuly completed transaction" } }, "required": [ "PCID", "transaction" ] } ``` *** ## paystack\_payments\_refund\_fetch Fetch Refund **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------------- | | `id` | integer | Yes | — | The identifier of the refund | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The identifier of the refund" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_refund\_list List Refunds **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------------------------------- | | `perPage` | integer | No | — | Number of records to fetch per page | | `page` | integer | No | — | The section to retrieve | | `from` | string | No | — | The start date | | `to` | string | No | — | The end date | ```json theme={null} { "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" }, "from": { "type": "string", "description": "The start date" }, "to": { "type": "string", "description": "The end date" } }, "required": [ "PCID" ] } ``` *** ## paystack\_payments\_refund\_retry Retry Refund **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------- | -------- | ------- | ----------------------------------------------------------------- | | `id` | integer | Yes | — | The identifier of the refund | | `refund_account_details` | object | Yes | — | An object that contains the customer’s account details for refund | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The identifier of the refund" }, "refund_account_details": { "type": "object", "description": "An object that contains the customer’s account details for refund", "properties": { "currency": { "type": "string", "description": "The currency of the customer's bank account. It should be the same as the currency the payment was made" }, "account_number": { "type": "string", "description": "The customer's account number" }, "bank_id": { "type": "string", "description": "The ID representing the customer's bank. You can get the list of bank IDs by calling the List Banks endpoint." } }, "required": [ "currency", "account_number", "bank_id" ] } }, "required": [ "PCID", "id", "refund_account_details" ] } ``` *** ## paystack\_payments\_transaction\_charge\_authorization Charge Authorization **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `amount` | integer | Yes | — | Amount in the lower denomination of your currency | | `authorization_code` | string | Yes | — | Valid authorization code to charge | | `bearer` | string | No | — | The bearer of the transaction charge | | `currency` | string | No | — | List of all support currencies | | `email` | string | Yes | — | Customer's email address | | `metadata` | string | No | — | Stringified JSON object of custom data | | `queue` | boolean | No | — | If you are making a scheduled charge call, it is a good idea to queue them so the processing system does not get overloaded causing transaction processing errors. | | `reference` | string | No | — | Unique transaction reference. Only -, ., = and alphanumeric characters allowed. | | `split` | object | No | — | Split configuration for transactions | | `split_code` | string | No | — | The split code of the transaction split | | `subaccount` | string | No | — | The code for the subaccount that owns the payment | | `transaction_charge` | string | No | — | A flat fee to charge the subaccount for a transaction. This overrides the split percentage set when the subaccount was created | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "amount": { "type": "integer", "description": "Amount in the lower denomination of your currency" }, "authorization_code": { "type": "string", "description": "Valid authorization code to charge" }, "bearer": { "type": "string", "description": "The bearer of the transaction charge", "enum": [ "account", "subaccount" ] }, "currency": { "type": "string", "description": "List of all support currencies", "enum": [ "GHS", "KES", "NGN", "ZAR", "USD" ] }, "email": { "type": "string", "description": "Customer's email address" }, "metadata": { "type": "string", "description": "Stringified JSON object of custom data" }, "queue": { "type": "boolean", "description": "If you are making a scheduled charge call, it is a good idea to queue them so the processing system does not get overloaded causing transaction processing errors." }, "reference": { "type": "string", "description": "Unique transaction reference. Only -, ., = and alphanumeric characters allowed." }, "split": { "type": "object", "description": "Split configuration for transactions", "properties": { "name": { "type": "string", "description": "Name of the transaction split" }, "type": { "type": "string", "description": "The type of transaction split you want to create.", "enum": [ "percentage", "flat" ] }, "subaccounts": { "type": "array", "items": { "type": "object" }, "description": "A list of object containing subaccount code and number of shares" }, "currency": { "type": "string", "description": "The transaction currency", "enum": [ "NGN", "GHS", "ZAR", "USD" ] }, "bearer_type": { "type": "string", "description": "This allows you specify how the transaction charge should be processed", "enum": [ "subaccount", "account", "all-proportional", "all" ] }, "bearer_subaccount": { "type": "string", "description": "This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type" } }, "required": [ "name", "type", "subaccounts", "currency" ] }, "split_code": { "type": "string", "description": "The split code of the transaction split" }, "subaccount": { "type": "string", "description": "The code for the subaccount that owns the payment" }, "transaction_charge": { "type": "string", "description": "A flat fee to charge the subaccount for a transaction. This overrides the split percentage set when the subaccount was created" } }, "required": [ "PCID", "amount", "authorization_code", "email" ] } ``` *** ## paystack\_payments\_transaction\_export Export Transactions **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | --------------------------------------- | | `from` | string | No | — | The start date | | `to` | string | No | — | The end date | | `status` | string | No | — | Filter by the status of the transaction | | `customer` | number | No | — | Filter by customer ID | | `subaccount_code` | string | No | — | Filter by subaccount code | | `settlement` | integer | No | — | Filter by the settlement ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "from": { "type": "string", "description": "The start date" }, "to": { "type": "string", "description": "The end date" }, "status": { "type": "string", "description": "Filter by the status of the transaction", "enum": [ "success", "failed", "abandoned", "reversed", "all" ] }, "customer": { "type": "number", "description": "Filter by customer ID" }, "subaccount_code": { "type": "string", "description": "Filter by subaccount code" }, "settlement": { "type": "integer", "description": "Filter by the settlement ID" } }, "required": [ "PCID" ] } ``` *** ## paystack\_payments\_transaction\_fetch Fetch Transaction **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------------------- | | `id` | integer | Yes | — | The ID of the transaction to fetch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the transaction to fetch" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_transaction\_initialize Initialize Transaction **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount` | integer | Yes | — | Amount should be in smallest denomination of the currency. | | `bearer` | string | No | — | The bearer of the transaction charge | | `callback_url` | string | No | — | Fully qualified url, e.g. [https://example.com/](https://example.com/) to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction | | `channels` | string\[] | No | — | An array of payment channels to control what channels you want to make available to the user to make a payment with | | `currency` | string | No | — | List of all support currencies | | `email` | string | Yes | — | Customer's email address | | `invoice_limit` | integer | No | — | Number of times to charge customer during subscription to plan | | `label` | string | No | — | Used to replace the email address shown on the Checkout | | `metadata` | object | No | — | JSON object of custom data | | `plan` | string | No | — | If transaction is to create a subscription to a predefined plan, provide plan code here. This would invalidate the value provided in amount | | `reference` | string | No | — | Unique transaction reference. Only -, ., = and alphanumeric characters allowed. | | `split` | object | No | — | Split configuration for transactions | | `split_code` | string | No | — | The split code of the transaction split | | `subaccount` | string | No | — | The code for the subaccount that owns the payment | | `transaction_charge` | string | No | — | A flat fee to charge the subaccount for a transaction. This overrides the split percentage set when the subaccount was created | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "amount": { "type": "integer", "description": "Amount should be in smallest denomination of the currency." }, "bearer": { "type": "string", "description": "The bearer of the transaction charge", "enum": [ "account", "subaccount" ] }, "callback_url": { "type": "string", "description": "Fully qualified url, e.g. https://example.com/ to redirect your customers to after a successful payment. Use this to override the callback url provided on the dashboard for this transaction" }, "channels": { "type": "array", "items": { "type": "string", "enum": [ "card", "bank", "ussd", "qr", "eft", "mobile_money", "bank_transfer" ] }, "description": "An array of payment channels to control what channels you want to make available to the user to make a payment with" }, "currency": { "type": "string", "description": "List of all support currencies", "enum": [ "GHS", "KES", "NGN", "ZAR", "USD" ] }, "email": { "type": "string", "description": "Customer's email address" }, "invoice_limit": { "type": "integer", "description": "Number of times to charge customer during subscription to plan" }, "label": { "type": "string", "description": "Used to replace the email address shown on the Checkout" }, "metadata": { "type": "object", "description": "JSON object of custom data" }, "plan": { "type": "string", "description": "If transaction is to create a subscription to a predefined plan, provide plan code here. This would invalidate the value provided in amount" }, "reference": { "type": "string", "description": "Unique transaction reference. Only -, ., = and alphanumeric characters allowed." }, "split": { "type": "object", "description": "Split configuration for transactions", "properties": { "name": { "type": "string", "description": "Name of the transaction split" }, "type": { "type": "string", "description": "The type of transaction split you want to create.", "enum": [ "percentage", "flat" ] }, "subaccounts": { "type": "array", "items": { "type": "object" }, "description": "A list of object containing subaccount code and number of shares" }, "currency": { "type": "string", "description": "The transaction currency", "enum": [ "NGN", "GHS", "ZAR", "USD" ] }, "bearer_type": { "type": "string", "description": "This allows you specify how the transaction charge should be processed", "enum": [ "subaccount", "account", "all-proportional", "all" ] }, "bearer_subaccount": { "type": "string", "description": "This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type" } }, "required": [ "name", "type", "subaccounts", "currency" ] }, "split_code": { "type": "string", "description": "The split code of the transaction split" }, "subaccount": { "type": "string", "description": "The code for the subaccount that owns the payment" }, "transaction_charge": { "type": "string", "description": "A flat fee to charge the subaccount for a transaction. This overrides the split percentage set when the subaccount was created" } }, "required": [ "PCID", "amount", "email" ] } ``` *** ## paystack\_payments\_transaction\_list List Transactions **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 | | `per_page` | integer | No | — | The number of records to fetch per request | | `page` | integer | No | — | The offset to retrieve data from | | `from` | string | No | — | The start date | | `to` | string | No | — | The end date | | `status` | string | No | — | Filter transaction by status | | `source` | string | No | — | The origin of the payment | | `terminal_id` | string | No | — | Filter transactions by a terminal ID | | `virtual_account_number` | string | No | — | Filter transactions by a virtual account number | | `customer_code` | string | No | — | Filter transactions by a customer code | | `amount` | integer | No | — | Filter transactions by a specific amount | | `settlement` | integer | No | — | The settlement ID to filter for settled transactions | | `channel` | string | No | — | The payment method the customer used to complete the transaction | | `subaccount_code` | string | No | — | Filter transaction by subaccount code | | `split_code` | string | No | — | Filter transaction by split code | ```json theme={null} { "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" }, "per_page": { "type": "integer", "description": "The number of records to fetch per request" }, "page": { "type": "integer", "description": "The offset to retrieve data from" }, "from": { "type": "string", "description": "The start date" }, "to": { "type": "string", "description": "The end date" }, "status": { "type": "string", "description": "Filter transaction by status", "enum": [ "success", "failed", "abandoned", "reversed" ] }, "source": { "type": "string", "description": "The origin of the payment", "enum": [ "merchantApi", "checkout", "pos", "virtualTerminal" ] }, "terminal_id": { "type": "string", "description": "Filter transactions by a terminal ID" }, "virtual_account_number": { "type": "string", "description": "Filter transactions by a virtual account number" }, "customer_code": { "type": "string", "description": "Filter transactions by a customer code" }, "amount": { "type": "integer", "description": "Filter transactions by a specific amount" }, "settlement": { "type": "integer", "description": "The settlement ID to filter for settled transactions" }, "channel": { "type": "string", "description": "The payment method the customer used to complete the transaction", "enum": [ "card", "pos", "bank", "dedicated_nuban", "ussd", "bank_transfer" ] }, "subaccount_code": { "type": "string", "description": "Filter transaction by subaccount code" }, "split_code": { "type": "string", "description": "Filter transaction by split code" } }, "required": [ "PCID" ] } ``` *** ## paystack\_payments\_transaction\_partial\_debit Partial Debit **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------- | | `amount` | integer | Yes | — | Specified in the lowest denomination of your currency | | `at_least` | string | No | — | Minimum amount to charge | | `authorization_code` | string | Yes | — | Valid authorization code to charge | | `currency` | string | Yes | — | List of all support currencies | | `email` | string | Yes | — | Customer's email address | | `reference` | string | No | — | Unique transaction reference. Only -, ., = and alphanumeric characters allowed. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "amount": { "type": "integer", "description": "Specified in the lowest denomination of your currency" }, "at_least": { "type": "string", "description": "Minimum amount to charge" }, "authorization_code": { "type": "string", "description": "Valid authorization code to charge" }, "currency": { "type": "string", "description": "List of all support currencies", "enum": [ "GHS", "KES", "NGN", "ZAR", "USD" ] }, "email": { "type": "string", "description": "Customer's email address" }, "reference": { "type": "string", "description": "Unique transaction reference. Only -, ., = and alphanumeric characters allowed." } }, "required": [ "PCID", "amount", "authorization_code", "currency", "email" ] } ``` *** ## paystack\_payments\_transaction\_timeline Fetch Transaction Timeline **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------------------- | | `id` | integer | Yes | — | The ID of the transaction to fetch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the transaction to fetch" } }, "required": [ "PCID", "id" ] } ``` *** ## paystack\_payments\_transaction\_totals Transaction Totals **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------- | | `from` | string | No | — | The start date | | `to` | string | No | — | The end date | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "from": { "type": "string", "description": "The start date" }, "to": { "type": "string", "description": "The end date" } }, "required": [ "PCID" ] } ``` *** ## paystack\_payments\_transaction\_verify Verify Transaction **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------------------- | | `reference` | string | Yes | — | The transaction reference to verify | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "reference": { "type": "string", "description": "The transaction reference to verify" } }, "required": [ "PCID", "reference" ] } ```