Skip to content

PaymentPlans

Retrieve List of Payment Plans

This endpoint is used to retrieve list of Payment Plans

Retrieve a Payment Plan

This endpoint is used to retrieve a specific Payment Plan using the paymentPlanId

Create a Payment within Payment Plan

This endpoint is used to create a payment using the paymentPlanId

Cancel Payment Plan

This endpoint is used to cancel a Payment Plan

List payments within a Payment Plan

This endpoint is used to list all the payments within a Payment Plan

Operations

Create payment within payment plan

Request

Create payment within payment plan

Security
bearer and basic and apiKey
Path
paymentPlanIdstringrequired

The Id of payment plan

Bodyapplication/jsonrequired
transIdstring, <= 64 charactersrequired

Transaction ID created in merchant's system. It should be unique for each payment.

refNrstring

Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually. It is recommended to limit the length to 18 characters so that it works for all payment methods. Allowed characters: letters (A-Z, a-z), digits (0-9), and the special characters - ? , ( ) + . ' :

amountobject(amountPaymentPlans)
statementDescriptorstring

Statement descriptor of the specific MIT.

orderobject(orderPaymentPlans)
curl -i -X POST \
  -u '<username>:<password>' \
  'https://test.computop-paygate.com/api/v2/payment-plans/{paymentPlanId}/charge' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "transId": "string",
    "refNr": "string",
    "amount": {
      "value": 0
    },
    "statementDescriptor": "string",
    "order": {
      "merchantReference": "string",
      "invoiceId": "string",
      "description": "string"
    }
  }'

Responses

Success

Bodyapplication/json
paymentPlanIdstring

The Id of payment plan

payIdstring

A unique identifier assigned by Computop Paygate to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation.

merchantIdstring

Merchant ID assigned by Computop Paygate.

transIdstring

Transaction ID provided by you in the request.

xIdstring

A unique identifier assigned by Computop Paygate for each operation in the payment. For example: xId will be different for the authorization and capture operations of a payment whereas payId will be same.

refNrstring

Reference number provided by you in the request.

statusstring

Status of the transaction.

responseCodestring

Response code of the transaction.

responseDescriptionstring

Response description associated with the response code.

metadataobject

A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs as you passed in the request.

Response
{
  "paymentPlanId": "string",
  "payId": "string",
  "merchantId": "string",
  "transId": "string",
  "xId": "string",
  "refNr": "string",
  "status": "string",
  "responseCode": "string",
  "responseDescription": "string",
  "metadata": {
    "property1": "string",
    "property2": "string"
  }
}