Create a payment plan

post

https://test-api.payology.io/customer-vault/api/v1/payment-plan

Creates a payment plan and its scheduled installments. Save the returned payment-plan token and use a unique reference ID for reconciliation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

org_bank_account_token

string | null

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Stringified UUIDv4.
See RFC 4112

payment_profile_token

string

required

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Stringified UUIDv4.
See RFC 4112

bypass_webhook

boolean

credit

boolean

source

string

enum

Allowed:

payment_plan_details

array of objects

required

payment_plan_details*

reference_id

string

required

reference_id_2

string | null

team_member_id

string | null

customer_ip

string | null

terminal_token

string | null

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Stringified UUIDv4.
See RFC 4112

Responses

201

Request completed successfully.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok