3.23. /api/v4/create-recurring-payments

Introduction

Create recurring payments Multiple is initiated through HTTPS POST request by using URLs and the parameters specified below. Use OAuth RSA-SHA256 for authentication.

API URLs

Integration

Production

https://sandbox.gitpay.tech/paynet/api/v4/create-recurring-payments/ENDPOINTID

https://gate.gitpay.tech/paynet/api/v4/create-recurring-payments/ENDPOINTID

Request Parameters

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.
Below is a description of each parameter that can be included in the CSV and added to payload parameter which will be used in the request.

Parameter Name

Description

Value

rp_card_type

SRC - Sender’s source card. DST - Receiver’s destination card.
Necessity: Required
Type: Enum
Length: 3

client-orderid

Connecting Party order ID. Supported for SRC and DST type.
Necessity: Required
Type: String
Length: 128

Merchant login

Connecting Party’s login name. Supported for SRC and DST type.
Necessity: Required
Type: String
Length: 20

Endpoint

Endpoint ID. Supported for SRC and DST type.
Necessity: Required
Type: Numeric
Length: 10

order_desc

Description of Recurring payment. Supported for SRC and DST type.
Necessity: Required
Type: Numeric
Length: 65K

credit-card-number

Payer`s credit card number. Supported for SRC and DST type.
Necessity: Required
Type: Numeric
Length: 20

currency

Currency type. Supported for SRC and DST type.
Necessity: Required
Type: String
Length: 3

country

Payer`s country. Not supported for DST.
Necessity: Required
Type: String
Length: 2

city

Payer`s city. Not supported for DST.
Necessity: Required
Type: String
Length: 128

zip-code

Payer`s zip-code. Not supported for DST.
Necessity: Required
Type: String
Length: 10

address1

Payer`s address. Not supported for DST.
Necessity: Required
Type: String
Length: 256

first-name

Payer`s first-name. Not supported for DST.
Necessity: Required
Type: String
Length: 128

last-name

Payer`s last-name. Not supported for DST.
Necessity: Required
Type: String
Length: 128

email

Payer`s email. Not supported for DST.
Necessity: Required
Type: String
Length: 128

card-printed-name

Payer`s card printed name. Required for SRC, optional for DST.
Necessity: Required/Optional
Type: String
Length: 128

expire-year

Payer`s card expire year. Required for SRC, optional for DST.
Necessity: Required/Optional
Type: Numeric
Length: 4

expire-month

Payer`s card expire month. Required for SRC, optional for DST.
Necessity: Required/Optional
Type: Numeric
Length: 2

amount

Amount of currency must be the same as currency on the project assigned. Upon reaching finish date, Recurring payment will go into stop status. Supported for SRC and DST type. Necessity becomes required if amount-from and amount-to or amount-sequence are not used.
Necessity: Required/Optional
Type: Numeric
Length: 10

amount-from

If the combination of amount-from and amount-to is chosen, every charge will be of random amount between these two numbers. Supported for SRC and DST type. Necessity becomes required if amount or amount-sequence are not used.
Necessity: Required/Optional
Type: Numeric
Length: 10

amount-to

If the combination of amount-from and amount-to is chosen, every charge will be of random amount between these two numbers. Supported for SRC and DST type. Necessity becomes required if amount or amount-sequence are not used.
Necessity: Required/Optional
Type: Numeric
Length: 10

amount-sequence

If amount sequence is chosen, client will be charged amounts from this list. Example of setting up amount sequence: 10.5, 24.6, 32.0. If repeats number is higher than amount sequence number of elements, every new charge will be with last amount in amount sequence. In order for charges to begin from the first amount in the chain, current repeats number must be set as 0. Supported for SRC and DST type. Necessity becomes required if amount-from and amount-to or amount are not used.
Necessity: Required/Optional
Type: Numeric
Length: 10

period

Possible values are: day, week and month. In case if daily is chosen, client will be charged every day. If week - every 7 days. If monthly is chosen, client will be charged on the same date of the month, from the starting date, no matter how many days there are in a month. Interval and period can only be specified or omitted together. Not supported for DST.
Necessity: Required/Optional
Type: String
Length: 32

interval

Interval is a multiplier applied to the period. For example, if interval of 2 and period ‘Daily’ is selected, client will be charged once every 2 days. Interval and period can only be specified or omitted together. Not supported for DST.
Necessity: Required/Optional
Type: Int
Length: -

ssn

Social security number field. Not supported for DST.
Necessity: Optional
Type: String
Length: 32

cvv2

Payer’s CVV2 code. CVV2 (Card Verification Value) is a three- or four-digit number printed on the back of the card in the signature area.
Necessity: Optional
Type: Numeric
Length: 3-4

birthday

Payer`s birthday date. Not supported for DST.
Necessity: Optional
Type: 8/Numeric, DD.MM.YYYY
Length: 8

phone

Payer`s phone number. Not supported for DST.
Necessity: Optional
Type: String
Length: 128

state

Payer’s state. Please see Mandatory State codes for a list of valid state codes. Required for USA, Canada and Australia.Not supported for DST.
Necessity: Optional
Type: String
Length: 2-3

start-date

Date, when first charge is scheduled. If start date is set as a current date and type is set as auto, first charge will be made today. Supported for SRC and DST type.
Necessity: Optional
Type: 8/Numeric, DD.MM.YYYY
Length: 8

finish-date

Date, when the Payer will be charged last time. Supported for SRC and DST type.
Necessity: Optional
Type: 8/Numeric, DD.MM.YYYY
Length: 8

max-repeats-number

Index of recurring transaction, first charge will hold the index of 0. Current repeats number increases even if a charge was unsuccessful. When current repeats number reaches max repeats number, Recurring payment goes into stop status and client is charged no more. If a charge was made automatically, no additional charges will be made(unless done manually), even if a recurring payment is stopped and rescheduled again. Supported for SRC and DST type.
Necessity: Optional
Type: Int
Length: -

purpose

Purpose of transaction. Not supported for DST.
Necessity: Optional
Type: String
Length: 128

notify_url

Notify url field. server_callback_url parameter can also be used. For more information please see Connecting Party Callbacks. Supported for SRC and DST type.
Necessity: Optional
Type: String
Length: 1024

server_callback_url

URL, where the transaction status is sent to. Connecting Party may use server callback URL for custom processing of the transaction completion, e.g. to collect payment data in the Connecting Party’s information system. For the list of parameters which come along with server callback to server_callback_url refer to Connecting Party callback parameters.
Necessity: Optional
Type: String
Length: 128

Response Parameters

Note

Response has Content-Type: text/html;charset=utf-8 header. All fields are x-www-form-urlencoded, with (0xA) character at the end of each parameter’s value.

Response Parameters

Description

type

The type of response. May be create-recurring-payment-response, validation-error, error. If type equals validation-error or error, error-message and error-code parameters contain error details.

recurring-payment-id

Recurring ID assigned to the order by GitPay.

status

See Status List for details.

serial-number

Unique number assigned by GitPay server to particular request from the Connecting Party.

Request Example

Enter your private key in PKCS#1 container to use debug. See RSA-SHA256 for details.

Note

Step 1. CSV-file create. To create a CSV-file for “Create recurring payments” operation, go to Tools -> Batch -> Create recurring payments. Download the Sample CSV file for this batch create-recurring-payments-example.csv. Add values that should be processed to all parameters in the CSV-file.
Step 2. Encode the reconfigured CSV-file to obtain a payload code. Open the Terminal and encode the file in base64 format using the following command:
base64 create-recurring-payments-example.csv

Note

Step 3. Make a request. To make a Create recurring payments request, write the obtained payload code to the terminal and make a request as it is shown below:
POST /paynet/api/v4/create-recurring-payments/ HTTP/1.1
Host: sandbox.gitpay.tech
User-Agent: curl/8.4.0
Accept: */*
Content-Type: application/x-www-form-urlencoded
Authorization: OAuth oauth_consumer_key="ErwinTestMerchant",oauth_signature_method="RSA-SHA256",oauth_timestamp="1727178538",oauth_nonce="cdtNANOCATq",oauth_version="1.0",oauth_signature="B5m%2FOQOSBgqWI%2F%2FG3GhZw2kCJZDda7J6fLpOu6wFyBEj60PJp5u1mqBnIufzkkmrSkyZkCT6v12WIhwE%2BWTtJ7Wg%2BRx9cqXPfhk5JhQpnofsVheXpCpftoLvvBTqn8p67WaS%2B6kfzGtGhdXHYVBzIxXDxabnMjMC8u8EtfWsovzTp%2BAYfZKn2H0qH7B62dfUW4PuRCTmy9svbwLhbPULkh3oJ3a1M%2BnRqXIasIrd3WY1MD9lkqUetAtW3xIWnOoMvPZ0wzk2UEbU%2BoZ2KTiA9KO09%2Ffq7OylRhiDpqtz65EMBiKujFFSF42bzYsB1SmPssk09xJoWmsNR9tFZsdx2Hgl7yFZTXhxV3nlSZTGDVZaVe2pPSi8va5W9yTlPMPU5HcNE5MuZ3T9PSEURQvM691UcPSdlJAi8q7B0EhXDzwOlgLV7DsFDtpsXSeXopFpG6uHiNPIjW65p6XFQ31xr4foZCahVeymuIoiXE6uAkHJJ89oHqKsOBnI7xILu2UpflHnl7gn%2BvX9IWdUHx1xEMdBPWdUQRFNllGvT2N8nYrtZe96L%2BfwxarYR2Fh1LtyqwCtEXhQm5jhjpR3NQpqddY3NSd75NUP7zlDQwXCknMQps6uSdng9Uv%2B7IFx3oNUfjVMxp4CGcmEtSxH7Ykx8dX5srNOKLDJT5tyExLLjXk%3D"
Content-Length: 754
Connection: keep-alive

payload=Y2xpZW50LW9yZGVyaWQ7cnBfY2FyZF90eXBlO29yZGVyX2Rlc2M7Zmlyc3QtbmFtZTtsYXN0LW5hbWU7YWRkcmVzczE7Y2l0eTt6aXAtY29kZTtjb3VudHJ5O3N0YXRlO3Bob25lO2VtYWlsO3BlcmlvZDtpbnRlcnZhbDtzdGFydC1kYXRlO2ZpbmlzaC1kYXRlO21heC1yZXBlYXRzLW51bWJlcjthbW91bnQ7YW1vdW50LWZyb207YW1vdW50LXRvO2Ftb3VudC1zZXF1ZW5jZTtjdXJyZW5jeTtjYXJkLXByaW50ZWQtbmFtZTtjcmVkaXQtY2FyZC1udW1iZXI7ZXhwaXJlLW1vbnRoO2V4cGlyZS15ZWFyO2N2djI7cHVycG9zZTtub3RpZnktdXJsO3NzbjtiaXJ0aGRheQ0KMTIzNDU2Nzg5MDtTUkM7O1dpbGw7U3RpbGw7MTIzNCBSZWluO1JlaW1zOzEyMzQ1NjtGUjtCUkU7MTIzNDU2Nzg7d2lsbHN0aWxsQGV4YW1wbGUuY29tO3dlZWs7MTsxNi4wOS4yMDI0OzE3LjA5LjIwMjQ7MTAwMDsxMDs7OztVU0Q7V0lMTCBTVElMTDs0NDU4MjA0NjgxMzg3MDUzOzEyOzIwNDA7MTIzO05vIHB1cnBvc2UgYXQgYWxsO2h0dHA6Ly9leGFtcGxlLmNvbS9jcmVhdGUtbWU7MTIzNDsyMi4wMS4xOTgwDQo%3D

Success Response Example

Note

The successful response has empty body and HTTP code 200.
HTTP/1.1 200
Server: server
Date: Tue, 24 Sep 2024 09:44:01 GMT
Content-Length: 0
Connection: keep-alive
Keep-Alive: timeout=60
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000
Strict-Transport-Security: max-age=31536000

Fail Response Example

Note

The unsuccessful response has empty body and HTTP code 403.
HTTP/1.1 403
Server: server
Date: Wed, 25 Sep 2024 08:45:42 GMT
Content-Length: 0
Connection: keep-alive
Keep-Alive: timeout=60
X-XSS-Protection: 1
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000

Postman Collection

Request Builder