Recurring Payment
Instruction Creation Method #
Creates a recurring payment instruction. You can use the following services to create recurring payment instructions.
Endpoint : https://paynkolaytest.nkolayislem.com.tr/Vpos/api/RecurringPaymentCreate
Method: POST
Example Request: #
{
"sx": "162883710|dfDdIIK....cWA==",
"language": null,
"Instalment": 2, // How many times the payment will be taken, max 12
"InstalmentPeriod": 30, // Cannot be a value other than 30
"CustomerName": "Bilge",
"CustomerMiddleName": "",
"CustomerSurname": "Demir",
"ClientRefCode": "APITEST001",
"PaymentStartChose": 1, // 1 for immediate payment, 2 for future-dated payment
"PaymentStartDate": "18/11/2024", // If PaymentStartChose is entered as 2, PaymentStartDate should be sent as a future date. If PaymentStartChose is entered as 1, the current day's date should be entered.
"Email": "bilge.demir123456@gmail.com",
"Gsm": "5555555555",
"Amount": "10",
"Description": "Create API test",
"hashDatav2": "",
"cardHolderIP": "134.233.53.2",
}Example Response: #
{
"LINK": "https://apptest.paynkolay.com.tr/recurring/payment?q=eyJhb...",
"INSTRUCTION_NUMBER": "ACPL00395013",
"RESPONSE_CODE": 2,
"ERROR_CODE": null,
"RESPONSE_DATA": "Transaction Successful.",
"sessionId": "30833435-7b85-440b-b34a-a8056fe53048",
"CORE_TRX_ID_RESERVED": "0D047D59-795D-43BE-A130-F5F95DF436E9",
"ERROR_MESSAGE": null,
"TimeStamp": null
}Instruction Cancel Method #
Cancels the recurring payment instruction.
Endpoint : https://paynkolaytest.nkolayislem.com.tr/Vpos/api/RecurringPaymentCancel
Method: POST
Example Request: #
{
"sx": "162883710|dfDdIIKo....",
"InstructionNumber": "ACPL00395012",
"hashDatav2": "",
"cardHolderIP": "134.233.53.2",
}Example Response: #
{
"CANCEL_INSTRUCTION": [{
"N_Kolay_Talimat_No": "ACPL00395012",
"Kalan_Odeme_Sayisi": "2",
"Tahsil_Edilmis_Odeme_Sayisi": "0"
}],
"RESPONSE_CODE": 2,
"ERROR_CODE": "CORE0302",
"RESPONSE_DATA": "Transaction Successful.",
"sessionId": "30833435-7b85-440b-b34a-a8056fe53048",
"CORE_TRX_ID_RESERVED": "CBF4C6A9-AA53-4596-9B6E-65607964ABD0",
"ERROR_MESSAGE": "Transaction Successful.",
"TimeStamp": null
}Instruction Listing Method #
Lists recurring payment instructions with their details.
Endpoint : https://paynkolaytest.nkolayislem.com.tr/Vpos/api/RecurringPaymentList
Method: POST
Example Request: #
{
"sx": "162883710|dfDdIIKo......",
"startDate": "29.07.2024",
"endDate": "29.07.2024",
"nameSurname": "",
"gsm": "",
"cardHolderIP": "134.233.53.2",
}Example Response: #
{
"INSTRUCTION_LIST": [
{
"ACTIVE": "Inactive",
"END_PAYMENT_DATE": "27.09.2024",
"CLIENT_REF_CODE": "APITEST001",
"TOTAL_PAYMENT_COUNT": "3",
"MERCHANT_NAME": "123456 - BILGE UAT",
"TRANSACTION_AMOUNT": "300.00",
"NEXT_PAYMENT_DATE": "29.07.2024",
"TRX_DATE": "29.07.2024",
"INSTRUCTION_STATUS": "Rejected",
"PERIOD": "Monthly",
"NAME_SURNAME": "Bilge Demir",
"INSTRUCTION_ID": "ACLD00347700",
"SUCCESSFUL_PAYMENT": "0",
"TOTAL_AMOUNT": "900.00",
"GSM": "05555555555"
},
{
"ACTIVE": "Active",
"END_PAYMENT_DATE": "22.08.2024",
"CLIENT_REF_CODE": " APITEST001",
"TOTAL_PAYMENT_COUNT": "2",
"MERCHANT_NAME": "123456 - BILGE UAT",
"TRANSACTION_AMOUNT": "200.00",
"NEXT_PAYMENT_DATE": "",
"TRX_DATE": "29.07.2024",
"INSTRUCTION_STATUS": "Closed",
"PERIOD": "Monthly",
"NAME_SURNAME": " Bilge Demir ",
"INSTRUCTION_ID": "ACLD00347630",
"SUCCESSFUL_PAYMENT": "1",
"TOTAL_AMOUNT": "400.00",
"GSM": "05555555555"
}
],
"TOTAL_COUNT": 1,
"RESPONSE_CODE": 2,
"ERROR_CODE": null,
"RESPONSE_DATA": "Transaction Successful.",
"sessionId": "30833435-7b85-440b-b34a-a8056fe53048",
"CORE_TRX_ID_RESERVED": "EE6E1663-A0A0-4DA8-95C0-318813F17085",
"ERROR_MESSAGE": null,
"TimeStamp": null
}