3.31. /api/v4/update-recurring-payments
Введение
API URL
Примечание
Интеграционная среда |
Производственная среда |
---|---|
https://sandbox.payneteasy.com/paynet/api/v4/update-recurring-payments/ENDPOINTID |
https://gate.payneteasy.com/paynet/api/v4/update-recurring-payments/ENDPOINTID |
Параметры запроса
Примечание
Примечание
Название параметра CSV |
Описание |
Значение |
---|---|---|
client-orderid |
Идентификатор заказа Присоединяющейся стороны. |
Необходимость : ОбязательноТип : StringДлина : 128 |
recurring-payment-id |
Повторяющийся идентификатор, присвоенный заказу отделом QA. |
Необходимость : ОбязательноТип : StringДлина : 128 |
credit-card-number |
Номер кредитной карты плательщика. |
Необходимость : ОбязательноТип : NumericДлина : 19 |
card-printed-name |
Напечатанное имя плательщика на карте. |
Необходимость : ОбязательноТип : StringДлина : 128 |
expire-year |
Срок истечения года карты плательщика. |
Необходимость : ОбязательноТип : NumericДлина : 4 |
expire-month |
Срок истечения месяца карты плательщика. |
Необходимость : ОбязательноТип : NumericДлина : 2 |
amount |
Сумма валюты должна совпадать с валютой назначенного проекта. По достижении даты окончания, регулярный платеж перейдет в статус - остановлен. Поддерживается для типов SRC и DST. Требуется, если не используются amount-from и amount-to или amount-sequence. |
Необходимость : УсловноТип : NumericДлина : 10 |
amount-from |
Если выбрана комбинация amount-from и amount-to, каждая плата будет иметь случайную сумму между этими двумя числами. Поддерживается для типов SRC и DST. Требуется, если amount или amount-sequence не используются. |
Необходимость : УсловноТип : NumericДлина : 10 |
amount-to |
Если выбрана комбинация amount-from и amount-to, каждая плата будет иметь случайную сумму между этими двумя числами. Поддерживается для типов SRC и DST. Требуется, если amount или amount-sequence не используются. |
Необходимость : УсловноТип : NumericДлина : 10 |
amount-sequence |
Если выбрана последовательность сумм, с клиента будет списана сумма из этого списка. Пример настройки последовательности сумм: 10.5, 24.6, 32.0. Если количество повторов больше количества элементов в последовательности сумм, каждое новое списание будет с последней суммы в последовательности сумм. Для того чтобы списание начиналось с первой суммы в цепочке, текущее количество повторов должно быть установлено как 0. Поддерживается для типов SRC и DST. Требуется, если amount-from и amount-to или amount не используются. |
Необходимость : УсловноТип : NumericДлина : 10 |
period |
Возможные значения: ежедневно, еженедельно и ежемесячно. В случае, если выбрано ежедневно, клиент будет платить каждый день. Если выбрано еженедельно - каждые 7 дней. Если выбрано ежемесячно, клиент будет платить в тот же день месяца, с начальной даты, независимо от того, сколько дней в месяце. Interval и period можно указывать или опускать только вместе. Не поддерживается для DST. |
Необходимость : УсловноТип : StringДлина : 32 |
interval |
Interval — это множитель, применяемый к периоду. Например, если интервал равен 2, а период выбран как «Ежедневно», клиент будет платить раз в 2 дня. Interval и period можно указывать или опускать только вместе. Не поддерживается для DST. |
Необходимость : УсловноТип : IntДлина : - |
country |
Страна плательщика. |
Необходимость : ОпциональноТип : StringДлина : 2 |
city |
Город плательщика. |
Необходимость : ОпциональноТип : StringДлина : 128 |
address1 |
Адрес плательщика. |
Необходимость : ОпциональноТип : StringДлина : 256 |
first-name |
Имя плательщика. |
Необходимость : ОпциональноТип : StringДлина : 128 |
last-name |
Фамилия плательщика. |
Необходимость : ОпциональноТип : StringДлина : 128 |
customer-ip |
IP-адрес плательщика. Поддерживается для типа SRC и DST. |
Необходимость : ОпциональноТип : StringДлина : 45 |
order_desc |
Описание повторяющегося платежа. |
Необходимость : ОпциональноТип : StringДлина : 65K |
zip-code |
Почтовый индекс плательщика. |
Необходимость : ОпциональноТип : StringДлина : 10 |
birthday |
Дата рождения плательщика. |
Необходимость : ОпциональноТип : 8/Numeric, DD.MM.YYYYДлина : 8 |
Электронная почта плательщика. |
Необходимость : ОпциональноТип : StringДлина : 128 |
|
ssn |
Поле номера социального страхования. |
Необходимость : ОпциональноТип : StringДлина : 32 |
phone |
Полный международный номер телефона плательщика, включая код страны. Не поддерживается для DST. |
Необходимость : ОпциональноТип : StringДлина : 128 |
state |
Штат плательщика. Список допустимых кодов штатов см. в разделе Обязательные коды штатов. Требуется для США, Канады и Австралии. Не поддерживается для DST. |
Необходимость : ОпциональноТип : StringДлина : 2-3 |
start-date |
Дата, когда запланировано первое списание. Если дата начала установлена как текущая дата и тип установлен как авто, первое списание будет произведено сегодня. |
Необходимость : ОпциональноТип : 8/Numeric, DD.MM.YYYYДлина : 8 |
finish-date |
Дата, когда с Плательщика будет взиматься плата в последний раз. |
Необходимость : ОпциональноТип : 8/Numeric, DD.MM.YYYYДлина : 8 |
max-repeats-number |
Индекс повторяющейся транзакции, первый платеж будет иметь индекс 0. Текущее число повторов увеличивается, даже если платеж был неудачным. Когда текущее число повторов достигает максимального числа повторов, повторяющийся платеж переходит в статус остановки, и клиент больше не платит. Если платеж был произведен автоматически, никаких дополнительных платежей не будет (если это не сделано вручную), даже если повторяющийся платеж остановлен и перенесен снова. |
Необходимость : ОпциональноТип : IntДлина : - |
purpose |
Цель транзакции. |
Необходимость : ОпциональноТип : StringДлина : 128 |
notify_url |
Поле Notify url. Также можно использовать параметр server_callback_url. Для получения дополнительной информации см. Обратный вызов Присоединяющейся Стороны. |
Необходимость : ОпциональноТип : StringДлина : 1024 |
server_callback_url |
Connecting Party URL which will receive callback request once the transaction reaches final status. 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. See callback details in Connecting Party callback parameters. Send either notify_url or server_callback_url, not both. |
Необходимость : ОпциональноТип : StringДлина : 128 |
Параметры ответа
Примечание
Параметры ответа |
Описание |
---|---|
type |
Тип ответа. Пример: update-recurring-payment-response, validation-error, error. Если тип равен validation-error или error, параметры error-message и error-code содержат сведения об ошибке. Могут быть получены несколько кодов ошибок: 200, 403 и 500. Для кода ошибки 500 будет возвращен дополнительный идентификатор ошибки. |
status |
Подробности смотрите в Список статусов |
serial-number |
Уникальный номер, присваиваемый сервером Payneteasy конкретному запросу от Торговца |
Пример запроса
"client-orderid";"recurring-payment-id";"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"
base64 update-recurring-payments-example.csv
POST /paynet/api/v4/update-recurring-payments/ HTTP/1.1
Host: sandbox.payneteasy.com
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="1727177782",oauth_nonce="Js4dwXkF8eI",oauth_version="1.0",oauth_signature="VwdA7BQ68v%2BmpB0N%2BUOxK%2BxYk355i1QzeUPGGGFwDEBn7Y8v1xpSolGQ45HehGmJHNjXHc7A1mP3x7V7r2pQju1LpDEvAb2MHNLSCHiCEjI95sCtrotE%2Fs5%2FmQmIJ8te%2FGFCR1uK%2BzMPG8bpHqn%2B5EIEsuLPq6TSOjD0N3RvnV%2BHdmjH5cxTcmtRrcY0u6VIpvkBUlqpKuTVJXLvbpxRexvgPMDow78QS3DLRQhi6G7Y%2FVshKpKC%2FSRThhe8L33tFckX6KaEbJ3XIMEmP7O%2F%2FQdLfWQBn4ldSp8K8lpkgZks4CZbAjDY%2BQpSfwdc1s8kJf17Ymk1R69aGBmjzJrw00tV4dzY4DE6XVqSTUR8X%2FCa0XMrtD46ichsFoRvFtIeyV%2FIud%2F%2FLSb8XDqk%2BaftSLazBokmT8Qe1FMf0UMgUYBLCl0B4O66Ys8kH4Z6guC2MXarwu%2BDlfuelrcAHevS68hewrMb%2FjppSJWAbQiBOABeW6s1Rb4dvbJnZribkKhEwrxmnT5drsTYvukC2UCoUblEOgVkFHdHk5E3OqT4wMxqXojlYr5Il7m1GkHVYELb964ukROLkohGoTjYEKj%2FUHirjybDWeynTCSaGe%2Bv3JtEbkydWXannkdtTvk0xkbT6LurBiNWy1FuSTmKod9ibqyNiEv6j%2Be14BBGXs3xc5A%3D"
Content-Length: 888
Connection: keep-alive
payload=cmVjdXJyaW5nLXBheW1lbnQtaWQ7dHlwZTtjbGllbnQtb3JkZXJpZDtwYXltZW50LWRlc2NyaXB0aW9uO2ZpcnN0LW5hbWU7bGFzdC1uYW1lO2FkZHJlc3MxO2NpdHk7emlwLWNvZGU7Y291bnRyeTtzdGF0ZTtwaG9uZTtlbWFpbDtjdXN0b21lci1pcDtwZXJpb2Q7aW50ZXJ2YWw7c3RhcnQtZGF0ZTtmaW5pc2gtZGF0ZTtjdXJyZW50LXJlcGVhdHMtbnVtYmVyO21heC1yZXBlYXRzLW51bWJlcjthbW91bnQ7YW1vdW50LWZyb207YW1vdW50LXRvO2Ftb3VudC1zZXF1ZW5jZTtjdXJyZW5jeTtjYXJkLXByaW50ZWQtbmFtZTtjcmVkaXQtY2FyZC1udW1iZXI7ZXhwaXJlLW1vbnRoO2V4cGlyZS15ZWFyO2N2djI7cHVycG9zZTtub3RpZnktdXJsO3NzbjtiaXJ0aGRheQ0KMTQ5MjI4NjttYW51YWw7MTIzNDU2Nzg5MDtPdXIgc3VwZXIgZ29vZHM7Sm9objtTbWl0aDsxMjM0IFBlYWNlIHN0cmVldDtDaGljYWdvOzEyMzQ1NjtVUztJTDsxMjM0NTY3ODtqb2huLnNtaXRoQGV4YW1wbGUuY29tOzEuMi4zLjQ7d2VlazsxOzAxLjAxLjIwMzA7MDEuMDEuMjA0MDswOzEwMDA7MTA7Ozs7VVNEO0pPSE4gU01JVEg7NDUzODA5NjQxNTA4NDc1NjsxMjsyMDIwOzEyMztObyBwdXJwb3NlIGF0IGFsbDtodHRwOi8vZXhhbXBsZS5jb20vbm90aWZ5LW1lOzEyMzQ7MDIuMDEuMTk4MA0K
Пример успешного ответа
Примечание
HTTP/1.1 200
Server: server
Date: Tue, 24 Sep 2024 11:40:45 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
Пример неуспешного ответа
Примечание
HTTP/1.1 403
Server: server
Date: Wed, 25 Sep 2024 08:47:54 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
Request Builder
Debug form
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 |
---|
Base64 Encoded Signature |
---|
|