3.22. /api/v4/create-recurring-payments
Introduction
Create recurring payments Batch 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
Parameter Name |
Description |
Value |
---|---|---|
client-orderid |
Connecting Party order ID. Supported for SRC and DST type. |
Necessity : RequiredType : StringLength : 128 |
rp_card_type |
SRC - source card. DST - destination card. |
Necessity : RequiredType : noneLength : none |
Endpoint |
Endpoint ID. Supported for SRC and DST type. |
Necessity : RequiredType : NumericLength : 10 |
credit-card-number |
Payer`s credit card number. Supported for SRC and DST type. |
Necessity : RequiredType : NumericLength : 20 |
card-printed-name |
Payer`s card printed name. Required for SRC, optional for DST. |
Necessity : Required/OptionalType : StringLength : 128 |
expire-year |
Payer`s card expire year. Required for SRC, optional for DST. |
Necessity : Required/OptionalType : NumericLength : 4 |
expire-month |
Payer`s card expire month. Required for SRC, optional for DST. |
Necessity : Required/OptionalType : NumericLength : 2 |
first-name |
Payer`s first-name. Not supported for DST. |
Necessity : RequiredType : StringLength : 128 |
last-name |
Payer`s last-name. Not supported for DST. |
Necessity : RequiredType : StringLength : 128 |
currency |
Currency type. Supported for SRC and DST type. |
Necessity : RequiredType : StringLength : 3 |
country |
Payer`s country. Not supported for DST. |
Necessity : RequiredType : StringLength : 2 |
city |
Payer`s city. Not supported for DST. |
Necessity : RequiredType : StringLength : 128 |
zip-code |
Payer`s zip-code. Not supported for DST. |
Necessity : RequiredType : StringLength : 10 |
address1 |
Payer`s address. Not supported for DST. |
Necessity : RequiredType : StringLength : 256 |
order_desc |
Description of Recurring payment. Supported for SRC and DST type. |
Necessity : OptionalType : NumericLength : 65K |
Payer`s email. Not supported for DST. |
Necessity : RequiredType : StringLength : 128 |
|
ssn |
Social security number field. Not supported for DST. |
Necessity : OptionalType : StringLength : 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 : OptionalType : NumericLength : 3-4 |
birthday |
Payer`s birthday date. Not supported for DST. |
Necessity : OptionalType : 8/Numeric, DDMMYYYYLength : 8 |
phone |
Payer`s phone number. Not supported for DST. |
Necessity : OptionalType : StringLength : 128 |
state |
Payer`s state. Not supported for DST. |
Necessity : OptionalType : StringLength : 2-3 |
period |
Period can be 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. Not supported for DST. |
Necessity : OptionalType : StringLength : 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. Not supported for DST. |
Necessity : OptionalType : intLength : - |
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 : OptionalType : 8/Numeric, DDMMYYYYLength : 8 |
finish-date |
Date, when the Payer will be charged last time. Supported for SRC and DST type. |
Necessity : OptionalType : 8/Numeric, DDMMYYYYLength : 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 : OptionalType : intLength : - |
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 : OptionalType : StringLength : 255 |
amount-from |
If amount from+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 and amount-sequence are not used. |
Necessity : OptionalType : StringLength : 255 |
amount-to |
If amount from+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 and amount-sequence are not used. |
Necessity : OptionalType : StringLength : 255 |
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 : OptionalType : StringLength : 255 |
purpose |
Purpose of transaction. Not supported for DST. |
Necessity : OptionalType : StringLength : 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 : OptionalType : StringLength : 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 : OptionalType : StringLength : 128 |
Response Parameters
Note
Response Parameters |
Description |
---|---|
type |
The type of response. Example: create-recurring-payment-response. |
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. |