- Create payment within payment plan
Cancel payment plan
Get list of payment plans
Get payment plan by id
List payments within a payment plan
Create payment within pay...
Create payment within payment plan
Security
bearer and basic and apiKey
Transaction ID created in merchant's system. It should be unique for each payment.
- Testhttps://test.paygate.nexigroup.com/api/v2/payment-plans/{paymentPlanId}/charge
- Productionhttps://paygate.nexigroup.com/api/v2/payment-plans/{paymentPlanId}/charge
curl -i -X POST \
-u '<username>:<password>' \
'https://test.paygate.nexigroup.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"
}
}'Success
A unique identifier assigned by Nexi 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.
A unique identifier assigned by Nexi 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.
Response
{ "paymentPlanId": "string", "payId": "string", "merchantId": "string", "transId": "string", "xId": "string", "refNr": "string", "status": "string", "responseCode": "string", "responseDescription": "string", "metadata": { "property1": "string", "property2": "string" } }