1.1.6. Recurring Payments service

Recurring (also Recurrent) payments transactions is a type of bank payments, where charges are applied to a cardholder in predetermined intervals for services or goods of an ongoing nature (memberships, subscriptions, loan payments). Prior to the charges, card must be registered in system. Charges will be made according to balancing set on project level.

Single operations

Recurring Payments API

Create Recurring Payments

Create Recurring Payments API URLs

Create Recurring Payments API call is initiated through HTTPS POST request by using URLs and the parameters specified below. See OAuth RSA-SHA256 for authentication.

https://sandbox.solidpayments.com/paynet/api/v4/create-recurring-payment/ENDPOINTID – for create transaction

Create Recurring Payments Request Parameters

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Create Recurring Payment request parameters	Length/Type	Source/Destination card type	Description	Necessity
rp_card_type	none	none	SRC - source card. DST - destination card.	Mandatory
client-orderid	128/String	SRC/DST	Merchant order ID	Mandatory
Merchant login	20/String	SRC/DST	Merchant’s login name	Mandatory
Endpoint	10/Numeric	SRC/DST	Endpoint ID	Mandatory
order_desc	65K/String	SRC/DST	Description of Recurring payment	Mandatory
credit-card-number	20/Numeric	SRC/DST	Clients credit card number	Mandatory
currency	3/String	SRC/DST	Currency type	Mandatory
country	2/String	Not supported for DST	Clients country.	Mandatory
city	128/String	Not supported for DST	Clients city.	Mandatory
zip-code	10/String	Not supported for DST	Clients zip-code.	Mandatory
address1	256/String	Not supported for DST	Clients address.	Mandatory
first-name	128/String	Not supported for DST	Clients first name.	Mandatory
last-name	128/String	Not supported for DST	Clients last name.	Mandatory
customer-ip	45/String	SRC/DST	Clients IP address	Mandatory
email	128/String	Not supported for DST	Clients email.	Mandatory
card-printed-name	128/String	Mandatory for SRC, optional for DST	Clients card printed name.	Mandatory/Optional
expire-month	2/Numeric	Mandatory for SRC, optional for DST	Clients card expire month.	Mandatory/Optional
expire-year	4/Numeric	Mandatory for SRC, optional for DST	Clients card expire year.	Mandatory/Optional
ssn	32/String	Not supported for DST	Social security number field.	Optional
birthday	8/Numeric, YYYYMMDD	Not supported for DST	Clients birthday date.	Optional
phone	128/String	Not supported for DST	Clients phone number.	Optional
state	2-3/String	Not supported for DST	Clients state.	Optional
period	32/String	Not supported for DST	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.	Optional
interval	int	Not supported for DST	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.	Optional
start-date	8/Numeric, YYYYMMDD	SRC/DST	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	Optional
finish-date	8/Numeric, YYYYMMDD	SRC/DST	Date, when the client will be charged last time	Optional
max-repeats-number	int	SRC/DST	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	Optional
amount	255/String	SRC/DST	Amount of currency must be the same as currency on the project assigned. Upon reaching finish date, Recurring payment will go into stop status	Optional
amount-from	255/String	SRC/DST	If amount from+amount to is chosen, every charge will be of random amount between these two numbers	Optional
amount-to	255/String	SRC/DST	If amount from+amount to is chosen, every charge will be of random amount between these two numbers	Optional
amount-sequence	255/String	SRC/DST	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	Optional
purpose	128/String	Not supported for DST	Purpose of transaction.	Optional
notify_url	1024/String	SRC/DST	Notify url field.:code:server_callback_url parameter can also be used. For more information please see _merchants_callbacks	Optional

Create Recurring Payment Request Example

address1=rpdDowning st., 10
amount=1.07
birthday=11.02.1996
card_printed_name=rpdA B
city=London
client_orderid=6685d0c4-c9e7-452d-bdcd-a41f2b341df5
country=GB
credit_card_number=4444555566661111
currency=USD
customer_ip=127.0.0.1
email=rpdG@example.com
expire_month=1
expire_year=2040
first_name=rpdA
last_name=rpdB
notify_url=http://localhost/rpdNotifyUrl
order_desc=rpdDsc
phone=+19834384
purpose=rpdPurpose
rp_card_type=SRC
server_callback_url=http://localhost/rpdServerCallbackUrl
ssn=rpdSsn
state=ABC
zip_code=898

Create Recurring Payment Response Parameters

Note

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

Create Recurring Payment Response Parameters	Description
type	The type of response. Example: create-recurring-payment-response
recurring-payment-id	Recurring ID assigned to the order by SolidPayments
status	See Status List for details
serial-number	Unique number assigned by SolidPayments server to particular request from the Merchant

Create Recurring Payments Response Example

recurring-payment-id=421
serial-number=00000000-0000-0000-0000-0000000005f6
status=approved
type=create-recurring-payment-response

Create Recurring Payments Debug

-----BEGIN RSA PRIVATE KEY----- MIIJKQIBAAKCAgEA16QK2iwgYUbMr2GqSbaS0PQZKF2DkstSj0dakW+hASTz5Ams R5sDnurfeR4m+Htaxiv69MMdvoDLuCmZE8KQzsEOZovZ9UYSh9CKK4/FzQSZ8ZDP 8cpKLN7/gitWiM14iuC9Pi74TTLeg7PuGjeoc0jUs0WMf7sV6uzfZwvqYgUVRljY gscwDRiTSGJQumQtanCs/LMIkxouThLztSSEmHhhEz2aWOomqR5hHO+HJ4I1AfET V7VpKJ4c1+zMesDfpDxZ8VpQpno9iikFG64MigDFmBeskI6q15tBwbROYSfqNEmG LwhYQ+SXnojueazkSJ45CeQRh6dn3GgD7kex2N3lK97qpqDcWOLqcsbe+ZyTGALn WGzTZWjleO+yrdE6awD34kUYVnzD/9WvdYqpH2pXBDqOIXu6lm4gLe5pKTRiFEc+ TjgVb34tJGEERkrvqktSEmRQzMgZQnZk/5//7+csUIcSPmqdUn5oB6ngVueZkk7v wtL6dcCxr5isWgXQEO+oYbt72Ns5RjLVWiXWv2ZNFd+iR4O6+etBxYNz+mg/2B5c PO8NWyvvFlaBUu4I5GG1XntBGWncKQiZ49WCvLcYEbSfUEkWLj6zqJaDS/buT3jU rWQ0WEI8G1HnTQp0cqmx9WpXDLx4n3ytRjHuHe3ND9AYE28yhfFY5baIU3UCAwEA AQKCAgAC4QrQDOTFx7c15DzszQY6yfeIBW+bRyGsDgzUgkQJCuBCvCpTrmsm9QXU zSVCDguRN8ca+3vrLjcKF2wWynM6f3NcxSM81hmrPIqLuFiwuw3/HqrYFJZW8QdC SqfWHcAtQoDkUqY4CaTU51MXgIS8PU2xsw0EK5BIWa9F5e/ULTMyhD8nx9cJZbmZ rs5bHrlIgYadvRoxNJlHq5MbaQhoLLtHEXx9EWtAuModI8mPKnrgssJKWn6z7yB9 dYjpXqfdvnyI72bCQkGOFaweyX0bXpVEyZQhPfZj+IuxNWIShADpf83N1POwvF2V 3Ugp0bgejBZA3o2pXP/S/oSG6ugh8dZHfa8vkw0x5N28393IzIMpzwE2EnsBidN1 ca7NwDpmpUyuULSpi3YoViUYY1i4Mwngv2XQdkbvoGusQwgWoNrppmDKxlL5qEBf lIPCZAgZSR79KHYw2VOzkm84hu0jDXMthpt9A2gLkRhGnGgb4n5KzyCpY9iuFK2w CO5FdjloXOjRLZb7G1JCeU6Qh0kjSE7seh9ltyo+VsWOLx4UwVOYGCMAF45yO0wF /MJdYoUt1vC5G/DK8itTTjwb/xPlGDiC441TOReWVwF6n36+shb6szlI2EmqKBkp 2Sr5xQ5VNZkcG2W/BUF7+n8Rvisu17TyW0HmwDEBDfJQzgzgpQKCAQEA7RpBNVBH Jx8gR7hQdbyi4/6U5KiYorkzuoK4KkjRWJfqJvp9uGZS2vDwOoIC8kCAXMwu3OCI U0xkDvH7bb/qedn0IG7+72FUCKlxqkMk4lv03zE9yUPcYNT+w573uh+rXQ/mcsFF +aBtupRZiDqqd4vuvjTpjw5Q4tyk/lxZfbe10S2NyxY4dZsbm8gl0SypLs/rLYjZ 8ZntRpZozIWoenrF3AnvtR114WBDpBVwSJ9KNd8xB5Fufc9TqsZ/EKPjDVrn2Sq2 Lt/xKSopwxPyIhKG1zmAeYhv8Q+GYUOQYCfBj2opDC3AOxANw2j9M8nYjCMDmPaP 5iDCUla35srp/wKCAQEA6NPj8auPGGFen2ZJoydpEPKgU3zAdv05VlKVIvbA9c+Y oy7zNhnNw0PCkkYpB9jPGvpdn6KFh2ZTU/mgmIysKriLcLN4gKho7JUCU3kvg1mv zJiz/5fR0xCCRNPLAANh6uJ+CXyssjbUoe9EmyVxKX3l2zKmy1zOKRc/FbAkql07 ItDReryb64IjsfT4GtU4nBK7zCzI+yya1BjL/McnGBcpKIwp9HCwaTQK7yxa7ThY TsfTuxoyZM1/xZE0cKRJGVLtkao1VfOy0SDdCp+RwtBvVmt3Wt6vVcL6qG0LW5Fe Uz0PN+CebMfhBCaqWXIXeuMUo+RdLnGn113Tl6i6iwKCAQEAz+NzRUGMAXtDHF84 /OJWmD1BY3OH0TU9a8ztmPWbyGf6gA6laKcfAqS6nTIdTzbK1ZKZjES6gv65xHjb ERFyj0BQ0pc/o7fcrHOVG8ofbvFdtMxB9lQvyB84+WBKqMDXyZMFZZyctBC75Rnp no6BpKvmupM+LZZJyX/YksV6GcaX/j5I0sY63rMO8/n7XnogJNFczOHu5e0mo/uB C8ItRKadER8NM+oOz3tOE3JQrvwrXyzAmngjPuAn5daA1qA7lhwcqMbQUi08D/HO CCNW7BT+cXsTcHv2WpBYLLPGxOhWyF42e10p7R9YUfud9miGG+kfYGDfLtGOUA+E 0zEbFQKCAQEA4lczDnqolpv5394RkiG6+zXTdLYfaM2NUwTfZOka9xxEl8cJuztk lAIoggjg1HcKB4EDSTA2vUVVlppjbEm9CZ70N7DRYcnWjr/hTgLOlNO4mp6Mxdny qkwvR/fZLf8bzrs2qcRhIrM5DN/NA0Jn+10f+nMIQUTMSpgFxPDDBDe0SIlWTApV TaLrTpIGLBfCe7+ef8O98qgPMEeW7vswXzQM2BVCqBZw+SUVyCOHlXukJZoPlKHI AcThBNC/eQ3M3miG+YfNZ+yMls9q82viyM/WnN3GXzmCnE37XYb8dp0gZK1EQR8F BF1fu6hXDLNkbhuZsiZMC92DvFPDYnkuNwKCAQA6/2K8PLlOeK+0p/IGVsgJpgHn Uh3BehVKHXeG/Buhn5bMXX3cB2hEHg2tz4pw3JxfZ1UflhyhKD43XnpxuMmt81Ka Ja5MeXDg0kfnlXolVA4ezx2V2EohMExUykkOIfQBDTaNtjsg5PB4HLKFId3kJ6u/ JCXuy0EA07vl/kNl+cDEBLJsVtvtxHLdpdJhO1POi3IIgOpddO+a/O/GDsdlAWog hyEb6r7+bWurjw0YjHX+R5ZQ+0XtnzXU20d2NiP/oH2IvQzXRUQ1U17Kzzn5PAhs YC7r9lRV4VjbhEi3Zk2FBPrrzs2ieXo5aHXCnzFywQ99nlrz0Ic8vV16WR1x -----END RSA PRIVATE KEY-----

Debug form

URL
Merchant login
Endpoint
client-orderid
payment-description
first-name
last-name
address1
city
zip-code
country
state
phone
email
customer-ip
period
interval
start-date
finish-date
max-repeats-number
amount
amount-from
amount-to
amount-sequence
currency
card-printed-name
credit-card-number
expire-month
expire-year
cvv2
purpose
notify-url
rp_card_type
ssn
birthday

Normalized parameters string to sign, according to OAuth 1.0a rules

POST body parameters to submit

OAuth 1.0a headers to submit.

HEX Encoded Signature

^{* HEX encoded string is for debug purposes only. You shouldn't send this string to the server neither in HEX nor in Encoded HEX representation.}

Base64 Encoded Signature

^{* Binary RSA-SHA256 signature directly encoded in base64 should be sent to the server.}

• CURL
• PHP
• Ruby
• Java

Copy to clipboard

Copy to clipboard

Copy to clipboard

Copy to clipboard

Process Recurring Payments (Source card only)

The End point ID is an entry point for incoming Merchant’s transactions. Create Recurring Payments API call is initiated through HTTPS POST request by using URLs and the parameters specified below. See OAuth RSA-SHA256 for authentication.

https://sandbox.solidpayments.com/paynet/api/v4/process-recurring-payment/ENDPOINTID – for process transaction

Recurring Payment Process Request Parameters

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Create Recurring Payment request parameters	Length/Type	Description	Necessity
client-orderid	128/String	Merchant order ID	Mandatory
recurring-payment-id	long	Recurring ID assigned to the order by SolidPayments	Mandatory
amount	255/String	Amount of currency must be the same as currency on the project assigned. Upon reaching finish date, Recurring payment will go into stop status	Mandatory

Process Recurring Payment Response Parameters

Note

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

Process Recurring Payment Response Parameters	Description
type	The type of response. Example: process-recurring-payment-response
status	See Status List for details
serial-number	Unique number assigned by SolidPayments server to particular request from the Merchant

Process Recurring Payments Debug

Process recurring payment debugger can be used to initiate a manual charge from a customer. Manual charges made this way do not interact with automatic charges in any way and they don`t increase any counters.

To reproduce your API call, input all of the data from your original request, including the authentication tokens. Don’t forget to set the nonce and timestamp to the values you used. An OAuth signed URL should match regardless of the generating library. If the signatures differ, you know there is a bug in your OAuth signature code. Due to current PCI DSS restrictions only OAuth 1.0a RSA-SHA256 signature is allowed. Other signature methods are restricted. So to send command to the server your request should be: sent as POST, contains OAuth 1.0a headers, signed with RSA-SHA256.

Generate Public and Private key pair

You need only private and public key to authorize your transaction. To generate it please got to https://www.openssl.org/ download latest version of openssl and run following commands:

openssl genpkey -algorithm RSA -out test-private-2048.pem -pkeyopt rsa_keygen_bits:2048
openssl rsa -pubout -in test-private-2048.pem -out test-public-2048.pem

Share your Private key with no one, you should be the only person to know it. Your Public key, on the contrary, should be sent to your manager, so he can register it in the system. Use different keys for production and for testing purposes to avoid its compromisation.

For using this demo you need private key in PKCS#8 container.

-----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDJzUVnqQhDWF2H pxAMcyo7f+ucIEJS3AQHG0ET/dxJ0qssGymIjdzelJ3XI+oTq2y9TTimQjtujoeh 6zl44WrXCbJLCUDWsNjlh7hmBorpU6tJVhw1466CAxkktPJHkMqJYF0efegIfOwU otTzwY4tGlN6iWK0aMJ5ZWhWpZDbgap72vrRXKfCN6/JeTUdsOI7PAeZw0me04jZ 8Lova9FVIbVzOJaFGwSUroMvXevIB8rOD57c3VCLTxE3aGNMz+9DLl6GCm8WZ1US HmiHybqgvGLyQswBPFcVzFgd7BpgZs+JAzYDh8ZGANvjA5F9u0b6Ynb3Mpm3+9Rl CtvSxKwpAgMBAAECggEAZ6+hro5KIZggjleHRm5Rz7p9S33DtiE3rJMTT/tKmV+1 9XaLU49YYcDIjMb2OV8GAwnPRpWXRcnT5J0grXxc0do4kpdRij3ZY63lT/6ilxoX Uxn8aq/udPy0iYizR5QcjJNHpSgZ9WqCPmQfuJLFw2TYaYh3f6yn54n0Hzj4gd9l tsol4xeTKQ47c/vUF7kHfD8IYzL8jv3a3++IqzCwJ3jIpTENsBYAgrkbYN9f9GHD BvX3sz6tgFaYU2R8YbDvA0Yq9tVPwYrPvbhwoht6PsjE/R0UK6yqnKPEADdzWvP8 frXmmtJ35rAymqUWfpqx9RdZ0NMR7J8ut8C5365PJQKBgQD+UidVWut7d9qvhZKq +T5qtasH5qkD34idFl4Ay8xsSntqTrXr7q1Ff+FQY6R+f/8IzB4ZqgnV58+8AEMc gJzNmkf9L119SCQDxRV/TgW2eHrUrI9XS2AI5tmyzaGY1xL4fCQQMvqNAGERT6sS XJRt8WjuGmE4zeqxNB0XY7u1OwKBgQDLIlnksOrPw00lWUbXHSHwdfBzjYU97KVu GnOl5fsCmlKanqHUfd/4StnRXpl3l56hig8mYsHV5EcfUEX98PaSbTAy8Lk5y5E9 ye2ENOgl/IyMgHPtT6spFKm7jRmpulqG4FVCGxQl3n6/nSmztA3S1zLZzi0guI0E oxXCbG796wKBgC8NSgOrr5eHRClnIAyL0nVxqPPsQ+bYi3Dsu3WQPwDmAtFXQKcm 4F3UW/5AgSV6Ttf007jR0cIGglN5BPGYBeqwGZOJGNXd6/PambCU4c+xmKASUO7I njrnYu2Gx9f8KqFYbl+k3uAJauwF/lOGV1vD5zLuJICa8Enap2s1Y3wTAoGBAKrx QnLISyIB+XbXtVyrYHdJ2Mp1Ks6cye5pBi9y5RQgqCkEG62FLCh3XOvrTvysNEs+ slccPoBv9UYtuGjmEanRhwEnQMiZPaWgu2dJWp8081X9dxEavS/5+oghSpphf3MH b9gMj5z6qvE3IfPfLs7iWCGgdquVgt6HG3Wc6J53AoGAc+ZYE8kMj2p9rtu1uJgX +VMbbdLEUqz3BPC9Tzq+eglUlYmwUK1xynKZfkEMcu5PncaBaNLU+GmYKKgw6wZS soEF1KvbBB4o6nZdlGo0BirOQ0ijHDWUvtuiaaWAQoQAhQwgqqV2IOC4UfkZ6ORf A/UW43A9wZq9kaEgb0YWOes= -----END PRIVATE KEY-----

Debug form

URL
Merchant login
Endpoint
recurring-payment-id
client-orderid
payment-description
first-name
last-name
address1
city
zip-code
country
state
phone
email
customer-ip
amount
currency
purpose
notify-url
ssn
birthday

Normalized parameters string to sign, according to OAuth 1.0a rules

POST body parameters to submit

OAuth 1.0a headers to submit.

HEX Encoded Signature

^{* HEX encoded string is for debug purposes only. You shouldn't send this string to the server neither in HEX nor in Encoded HEX representation.}

Base64 Encoded Signature

^{* Binary RSA-SHA256 signature directly encoded in base64 should be sent to the server.}

• cURL
• Java

Copy to clipboard

Copy to clipboard

Recurring payment update

Create Recurring Payments API call is initiated through HTTPS POST request by using URLs and the parameters specified below. See OAuth RSA-SHA256 for authentication.

https://sandbox.solidpayments.com/paynet/api/v4/update-recurring-payment/ENDPOINTID – for update transaction

Update Recurring Payment Request Parameters

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Create Recurring Payment request parameters	Length/Type	Source/Destination card	Description	Necessity
client-orderid	128/String	SRC/DST	Merchant order ID	Mandatory
recurring-payment-id	long	SRC/DST	Recurring ID assigned to the order by SolidPayments	Mandatory
Merchant login	20/String	SRC/DST	Merchant’s login name	Mandatory
Endpoint	10/Numeric	SRC/DST	Endpoint ID	Mandatory
order_desc	65K/String	SRC/DST	Description of Recurring payment	Mandatory
type	auto/manual	SRC/DST	Recurring payments can be set as auto and manual. If set as auto, charges will be applied automatically in accordance with this schedule. If set as manual, client can be charged only manually with the help of Recur transaction/API call	Optional
credit-card-number	20/Numeric	SRC/DST	Clients credit card number	Optional
card-printed-name	128/String	SRC/DST	Clients card printed name	Optional
expire-month	2/Numeric	SRC/DST	Clients card expire month	Optional
expire-year	4/Numeric	SRC/DST	Clients card expire year	Optional
first-name	128/String	Not supported for DST	Clients first name.	Optional
last-name	128/String	Not supported for DST	Clients last name.	Optional
birthday	8/Numeric, YYYYMMDD	Not supported for DST	Clients birthday date.	Optional
customer-ip	45/String	SRC/DST	Clients IP address	Optional
ssn	32/String	Not supported for DST	Social security number field.	Optional
country	2/String	Not supported for DST	Clients country.	Optional
state	2-3/String	Not supported for DST	Clients state.	Optional
city	128/String	Not supported for DST	Clients city.	Optional
zip-code	10/String	Not supported for DST	Clients zip-code.	Optional
address1	256/String	Not supported for DST	Clients address.	Optional
phone	128/String	Not supported for DST	Clients phone number.	Optional
email	128/String	Not supported for DST	Clients email.	Optional
period	32/String	Not supported for DST	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.	Optional
interval	int	Not supported for DST	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.	Optional
start-date	8/Numeric, YYYYMMDD	SRC/DST	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	Optional
finish-date	8/Numeric, YYYYMMDD	SRC/DST	Date, when the client will be charged last time	Optional
max-repeats-number	int	SRC/DST	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	Optional
amount	255/String	SRC/DST	Amount of currency must be the same as currency on the project assigned. Upon reaching finish date, Recurring payment will go into stop status	Optional
amount-from	255/String	SRC/DST	If amount from+amount to is chosen, every charge will be of random amount between these two numbers	Optional
amount-to	255/String	SRC/DST	If amount from+amount to is chosen, every charge will be of random amount between these two numbers	Optional
amount-sequence	255/String	SRC/DST	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	Optional
purpose	128/String	Not supported for DST	Purpose of transaction.	Optional
notify_url	1024/String	SRC/DST	Notify url field. server_callback_url parameter can also be used. For more information please see merchants_callbacks	Optional

Update Recurring Payment Response Parameters

Note

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

Update Recurring Payment Response Parameters	Description
type	The type of response. Example: update-recurring-payment-response
status	See Status List for details
serial-number	Unique number assigned by SolidPayments server to particular request from the Merchant

Update Recurring Payment Request Example

address1=Downing st., 10
amount=2.08
birthday=12.03.1996
card_printed_name=A B
city=London
client_orderid=9f37992f-3b4d-476a-960f-536a953ba7bf
country=GB
credit_card_number=5555666644441111
email=g@example.com
expire_month=2
expire_year=2042
first_name=A
last_name=B
order_desc=dsc2
phone=+19834384
purpose=aPurpose
recurring_payment_id=2
server_callback_url=http://localhost/aServerCallbackUrl
ssn=aSsn
state=ABC
zip_code=898

Update Recurring Payment Response Example

serial-number=00000000-0000-0000-0000-000000000005
status=approved
type=update-recurring-payment-response

Update Recurring Payments Debug

Generate Public and Private key pair

You need only private and public key to authorize your transaction. To generate it please got to https://www.openssl.org/ download latest version of openssl and run following commands:

openssl genpkey -algorithm RSA -out test-private-2048.pem -pkeyopt rsa_keygen_bits:2048
openssl rsa -pubout -in test-private-2048.pem -out test-public-2048.pem

Share your Private key with no one, you should be the only person to know it. Your Public key, on the contrary, should be sent to your manager, so he can register it in the system. Use different keys for production and for testing purposes to avoid its compromisation.

For using this demo you need private key in PKCS#8 container.

-----BEGIN PRIVATE KEY----- MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDJzUVnqQhDWF2H pxAMcyo7f+ucIEJS3AQHG0ET/dxJ0qssGymIjdzelJ3XI+oTq2y9TTimQjtujoeh 6zl44WrXCbJLCUDWsNjlh7hmBorpU6tJVhw1466CAxkktPJHkMqJYF0efegIfOwU otTzwY4tGlN6iWK0aMJ5ZWhWpZDbgap72vrRXKfCN6/JeTUdsOI7PAeZw0me04jZ 8Lova9FVIbVzOJaFGwSUroMvXevIB8rOD57c3VCLTxE3aGNMz+9DLl6GCm8WZ1US HmiHybqgvGLyQswBPFcVzFgd7BpgZs+JAzYDh8ZGANvjA5F9u0b6Ynb3Mpm3+9Rl CtvSxKwpAgMBAAECggEAZ6+hro5KIZggjleHRm5Rz7p9S33DtiE3rJMTT/tKmV+1 9XaLU49YYcDIjMb2OV8GAwnPRpWXRcnT5J0grXxc0do4kpdRij3ZY63lT/6ilxoX Uxn8aq/udPy0iYizR5QcjJNHpSgZ9WqCPmQfuJLFw2TYaYh3f6yn54n0Hzj4gd9l tsol4xeTKQ47c/vUF7kHfD8IYzL8jv3a3++IqzCwJ3jIpTENsBYAgrkbYN9f9GHD BvX3sz6tgFaYU2R8YbDvA0Yq9tVPwYrPvbhwoht6PsjE/R0UK6yqnKPEADdzWvP8 frXmmtJ35rAymqUWfpqx9RdZ0NMR7J8ut8C5365PJQKBgQD+UidVWut7d9qvhZKq +T5qtasH5qkD34idFl4Ay8xsSntqTrXr7q1Ff+FQY6R+f/8IzB4ZqgnV58+8AEMc gJzNmkf9L119SCQDxRV/TgW2eHrUrI9XS2AI5tmyzaGY1xL4fCQQMvqNAGERT6sS XJRt8WjuGmE4zeqxNB0XY7u1OwKBgQDLIlnksOrPw00lWUbXHSHwdfBzjYU97KVu GnOl5fsCmlKanqHUfd/4StnRXpl3l56hig8mYsHV5EcfUEX98PaSbTAy8Lk5y5E9 ye2ENOgl/IyMgHPtT6spFKm7jRmpulqG4FVCGxQl3n6/nSmztA3S1zLZzi0guI0E oxXCbG796wKBgC8NSgOrr5eHRClnIAyL0nVxqPPsQ+bYi3Dsu3WQPwDmAtFXQKcm 4F3UW/5AgSV6Ttf007jR0cIGglN5BPGYBeqwGZOJGNXd6/PambCU4c+xmKASUO7I njrnYu2Gx9f8KqFYbl+k3uAJauwF/lOGV1vD5zLuJICa8Enap2s1Y3wTAoGBAKrx QnLISyIB+XbXtVyrYHdJ2Mp1Ks6cye5pBi9y5RQgqCkEG62FLCh3XOvrTvysNEs+ slccPoBv9UYtuGjmEanRhwEnQMiZPaWgu2dJWp8081X9dxEavS/5+oghSpphf3MH b9gMj5z6qvE3IfPfLs7iWCGgdquVgt6HG3Wc6J53AoGAc+ZYE8kMj2p9rtu1uJgX +VMbbdLEUqz3BPC9Tzq+eglUlYmwUK1xynKZfkEMcu5PncaBaNLU+GmYKKgw6wZS soEF1KvbBB4o6nZdlGo0BirOQ0ijHDWUvtuiaaWAQoQAhQwgqqV2IOC4UfkZ6ORf A/UW43A9wZq9kaEgb0YWOes= -----END PRIVATE KEY-----

Debug form

URL
Merchant login
Endpoint
recurring-payment-id
type
client-orderid
payment-description
first-name
last-name
address1
city
zip-code
country
state
phone
email
customer-ip
period
interval
start-date
finish-date
max-repeats-number
amount
amount-from
amount-to
amount-sequence
currency
card-printed-name
credit-card-number
expire-month
expire-year
cvv2
purpose
notify-url
ssn
birthday

Normalized parameters string to sign, according to OAuth 1.0a rules

POST body parameters to submit

OAuth 1.0a headers to submit.

HEX Encoded Signature

^{* HEX encoded string is for debug purposes only. You shouldn't send this string to the server neither in HEX nor in Encoded HEX representation.}

Base64 Encoded Signature

^{* Binary RSA-SHA256 signature directly encoded in base64 should be sent to the server.}

• cURL
• Java

Copy to clipboard

Copy to clipboard

Batch operations

Recurring payments are added and updated in the system in batches. In order to do it, navigate to “Tools - Batch operations”.

Note

To add or update recurring payments, download an example presented, fill in your clients, following an example, and upload it.

Warning

Microsoft Excel can display .csv files wrong, for better user experience a different office suite, for instance, LibreOffice. Only “amount” OR “amount from” + “amount to” OR “amount sequence” should be filled in.

Update of recurring payments is done on “Update recurring payments” page in the same way. Recurring transactions will be updated based on “Recurring payment ID” parameter.

Recurring Payments Batch API

Create Recurring Payments API call is initiated through HTTPS POST request by using URLs and the parameters specified below. See OAuth RSA-SHA256 for authentication.

https://sandbox.solidpayments.com/paynet/api/v4/create-recurring-payments/ENDPOINTID – for create transaction

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Add Document request parameters	Length/Type	Description	Necessity
client-orderid	128/String	Merchant order ID	Mandatory
Merchant login	20/String	Merchant’s login name	Mandatory
Endpoint	10/Numeric	Endpoint ID	Mandatory
payment-description	65K/String	Description of Recurring payment	Mandatory
first-name	128/String	Clients first name	Mandatory
last-name	128/String	Clients last name	Mandatory
customer-ip	45/String	Clients IP address	Mandatory
country	2/String	Clients country	Mandatory
address1	256/String	Clients address	Mandatory
zip-code	10/String	Clients zip-code	Mandatory
phone	128/String	Clients phone number	Mandatory
email	128/String	Clients email	Mandatory
currency	3/String	Currency type	Mandatory
card-printed-name	128/String	Clients card printed name	Mandatory
credit-card-number	20/Numeric	Clients credit card number	Mandatory
expire-month	2/Numeric	Clients card expire month	Mandatory
expire-year	4/Numeric	Clients card expire year	Mandatory
notify-url	1024/String	Notify url field	Mandatory
birthday	8/Numeric, YYYYMMDD	Clients birthday date	Optional
state	2-3/String	Clients state	Optional
purpose	128/String	Purpose of transaction	Optional
ssn	32/String	Social security number field	Optional
cvv2	3-4/Numeric	Clients cvv2 code	Optional
period	32/String	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	Optional
interval	int	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	Optional
start-date	8/Numeric, YYYYMMDD	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	Optional
finish-date	8/Numeric, YYYYMMDD	Date, when the client will be charged last time	Optional
max-repeats-number	int	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	Optional
amount	255/String	Amount of currency must be the same as currency on the project assigned. Upon reaching finish date, Recurring payment will go into stop status	Optional
amount-from	255/String	If amount from+amount to is chosen, every charge will be of random amount between these two numbers	Optional
amount-to	255/String	If amount from+amount to is chosen, every charge will be of random amount between these two numbers	Optional
amount-sequence	255/String	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	Optional

The End point ID is an entry point for incoming Merchant’s transactions.

https://sandbox.solidpayments.com/paynet/api/v4/update-recurring-payments/ENDPOINTID – for update transaction

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Update request parameters	Length/Type	Description	Necessity
recurring-payment-id	long	ID assigned by SolidPayments	Mandatory
type	auto/manual	Recurring payments can be set as auto and manual. If set as auto, charges will be applied automatically in accordance with this schedule. If set as manual, client can be charged only manually with the help of Recur transaction/API call	Mandatory
Merchant login	20/String	Merchant’s login name	Mandatory
Endpoint	40/Numeric	Endpoint ID	Mandatory
client-orderid	128/String	Merchant order ID	Optional
payment-description	65K/String	Description of Recurring payment	Optional
first-name	128/String	Clients first name	Optional
last-name	128/String	Clients last name	Optional
address1	256/String	Clients address	Optional
birthday	8/Numeric, YYYYMMDD	Clients birthday date	Optional
zip-code	10/String	Clients zip-code	Optional
country	2/String	Clients country	Optional
state	2-3/String	Clients state	Optional
phone	128/String	Clients phone number	Optional
email	128/String	Clients email	Optional
ssn	32/String	Social security number field	Optional
period	32/String	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	Optional
interval	int	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	Optional
start-date	8/Numeric, YYYYMMDD	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	Optional
finish-date	8/Numeric, YYYYMMDD	Date, when the client will be charged last time	Optional
max-repeats-number	int	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	Optional
amount	255/String	Amount of currency must be the same as currency on the project assigned. Upon reaching finish date, Recurring payment will go into stop status	Optional
amount-from	255/String	Amount of currency must be the same as currency on the project assigned. Upon reaching finish date, Recurring payment will go into stop status	Optional
amount-to	255/String	If amount from+amount to is chosen, every charge will be of random amount between these two numbers	Optional
amount-sequence	255/String	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	Optional
currency	3/String	Currency type	Optional
card-printed-name	128/String	Clients card printed name	Optional
credit-card-number	20/Numeric	Clients credit card number	Optional
expire-month	2/Numeric	Clients card expire month	Optional
expire-year	255/String	Clients card expire year	Optional
cvv2	3-4/Numeric	Clients cvv2 code	Optional
purpose	128/String	Purpose of transaction	Optional
notify-url	1024/String	Notify url field	Optional

The End point ID is an entry point for incoming Merchant’s transactions.

https://sandbox.solidpayments.com/paynet/api/v4/process-recurring-payments/ENDPOINTID – for process transaction

Note

Request must have content-type=application/x-www-form-urlencoded and Authorization headers.

Recurring payment request parameters	Length/Type	Description	Necessity
recurring-payment-id	long	ID assigned by SolidPayments	Mandatory
Merchant login	20/String	Merchant’s login name	Mandatory
Endpoint	40/String	Endpoint ID	Mandatory
payment-description	65K/String	Description of Recurring payment	Mandatory
amount	255/String	Amount of currency must be the same as currency on the project assigned. Upon reaching finish date, Recurring payment will go into stop status	Mandatory
currency	3/String	Currency type	Mandatory
client-orderid	128/String	Merchant order ID	Optional
first-name	128/String	Clients first name	Optional
last-name	128/String	Clients last name	Optional
birthday	8/Numeric, YYYYMMDD	Clients birthday date	Optional
address1	256/String	Clients address	Optional
zip-code	10/String	Clients zip-code	Optional
country	2/String	Clients country	Optional
state	2-3/String	Clients state	Optional
phone	128/String	Clients phone number	Optional
email	128/String	Clients email	Optional
ssn	32/String	Social security number field	Optional
purpose	128/String	Purpose of transaction	Optional
notify-url	1024/String	Notify url field	Optional

Recurring payments page overview

Once recurring payments are registered in the system, you can view full list of them in “Orders - Recurring payments”

Recurrence details section presents general information about the transaction. Recurrence ID can be found here, which is used for updating recurring payments.

Customer details section shows general information about client (city, e-mail, etc). Note, that this info can be changed for further Recurring charges.

Actions history page shows history of changes in this Recurring payment (schedule changes, status changes, manual charges), data and status of these actions.

Recurring Schedule Parameters	Description
Type	Recurring payments can be set as auto and manual. If set as auto, charges will be applied automatically in accordance with this schedule. If set as manual, client can be charged only manually with the help of Recur transaction/API call
Period	Period can be daily, weekly and monthly. In case if daily is chosen, client will be charged every day. If weekly - 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	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
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
Finish date	Date, when the client will be charged last time
Max & current 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
Currency	Currency of recurring payments, must be the same as currency on the project assigned. Upon reaching finish date, Recurring payment will go into stop status
Exact amount	If exact amount is chosen, every charge will be of that amount
Amount from/amount to	If amount from+amount to is chosen, every charge will be of random amount between these two numbers
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

Native type is reserved for future use and is not yet functional.

Current status can be “scheduled” or “stopped” and represents if this recurring transaction is turned on or off.

Processing status can hold the following values:

• idle - recurring payment is currently not queued to be processed
• queued - recurring payment is in queue to be processed.
• dequeued - recurring payment is taken out of the processing queue to be executed.
• processing - recurring payment is currently being processed
• failed - transaction has not received a final status and needs to be finalized.

Next fire date is a date when client will be charged next time.

Change card data action allows you to change data of the card to be charged.

Recur transaction action is a manual charge of a client. It won`t increase repeats number counter. Manual charges made this way do not interact with automatic charges in any way.

Suspend action lets you stop future charges on current recurring transaction.