UNPKG

@defra-fish/recurring-payments-job

Version:

Rod Licensing Recurring Payments Job

github.com/DEFRA/rod-licensing

DEFRA/rod-licensing

26 lines (16 loc) • 1.96 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Rod Licensing - Recurring Payments After taking the initial payment, a recurring payment will be setup in a new CRM entity. The Recurring Payments (RP) job, running on a regular schedule instructs GovPay to take payment for all non cancelled recurring payments due on the day When the RP job runs, all RP entries with an nextDueDate of the current date, a null cancelledDate and an active ('1') status field are retrieved, along with the associated Permissions. A new Permission for an identical Permit with a startDate equal to the endDate of the activePermission is provisioned and payment taken via the Gov.UK Pay interface. # Environment variables | name | description | required | default | valid | notes | | ------------------------------ | --------------------------------------------------------------- | :------: | ------------------- | ----------------------------- | ----- | | NODE_ENV | Node environment | no | | development, test, production | | | RUN_RECURRING_PAYMENTS | Determine whether to run recurring payments job or not | yes | | | | | SALES_API_URL | URL for the sales API | no | http://0.0.0.0:4000 | | | | SALES_API_TIMEOUT_MS | The timeout in milliseconds requests to the API | no | 10000 | | | | RECURRING_PAYMENTS_LOCAL_DELAY | Delay for running recurring payments until sales api is running | no | | | | ### See also: - # Prerequisites See [main project documentation](../../README.md).