APIs
Sub-processorsAbout PismoContact us

Migrate recurring charge links

post
https://gw-pci.pismolabs.io/migrations/v1/migrations/recurring-charge-links

Start migration of recurring charge links for an account. (A recurring charge link associates an active recurring charge plan with an account, so that the charges defined for the plan are applied to the account.)

This endpoint generates the following events:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Migrates recurring charge links

migration
object
required

Additional migration details

links
array of objects
required
length ≥ 1
links*
string
required

Link migration ID. ID for the relationship link between account and plan.

string
required

Migration date for updated data. Valid format (yyyy-MM-ddTHH:mm:ssZ).

string
length ≤ 100

Description of the scheduled charge that's linked to the account. Use {counter} to specify where the cycle count should be placed. For example, the Annuity {counter} generates Annuity 2/12 for the second of twelve annuities. If {counter} has not passed, it is placed at the end of the description. If no description is passed, the transaction type's description is used and the counter is not shown.

boolean
Defaults to true

Apply the recurring charge on the current account cycle? When false, apply charge in the next account cycle.

integer

ID of the recurring charge plan to link to the account. When this field is passed, the value in recurring_charge_plan_migration_id is ignored.

string

Migration ID of the recurring charge plan to link to the account, in cases where the plan was also migrated. Either this field or recurring_charge_plan_id is REQUIRED.

boolean
Defaults to false

Renew link automatically after the last cycle?

integer

The installment at which charges begin. For example, if start_installment_charge_in is 3, the charge is applied starting with cycle 3. It's not applied to cycles 1 and 2. If post_installment_charge_on_current_cycle is true, start_installment_charge_in should be null. If false, it must be greater than or equal to the current cycle and less than or equal to number_of_cycles.

string
enum

Migration origin

Allowed:
Responses
202

Accepted

Updated 20 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago