Create a recurring profile

post

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

Creates a recurring payment profile for a customer and payment method. Save the returned recurring 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

credit

boolean

required

recurring_type

string

enum

required

Allowed:

first_bill_date

string

required

first_bill_amount

double

required

x_day_of_month

double | null

every_x_days

double | null

recur_amount

double

required

recur_frequency

double

start_this_month

boolean

required

reference_id

string

required

reference_id_2

string | null

team_member_id

string | null

customer_ip

string | null

bypass_webhook

boolean | 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

source

string | null

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