Create a recurring document payable

POST/v1/recurring-payables

Authorization

AuthorizationBearer token · headerrequired

Public API key bearer token.

Query parameters

environmentstringrequired

merchantAccountIdstringrequired

Header parameters

Idempotency-Keystring

Required for production-safe retries on mutating routes. Reusing a key with a different request body returns 409.

min length 1

Request body

requiredapplication/json

sourceTypestringrequired

Allowed:document_payment_field

sourceIdstringrequired

documentIdstringrequired

paymentFieldIdstringrequired

customerExternalIdstringrequired

billingAccountIdstringrequired

merchantAccountIdstring

currencystringrequired

ISO 4217 alpha-3; only currencies processable on current rails are accepted

lineItemsPayableLineItem[]required

taxModestringrequired

Allowed:not_taxabletaxable_requires_evidence

taxableboolean

taxBehaviorstring

Allowed:inclusiveexclusive

taxClassificationKeystring

Allowed:standard_taxable

collectionIntentstringrequired

Allowed:manual

feePolicyFeePolicyrequired

Adopter fee policy (modeled, not settlement-executed). Structure passed through to Vortex Payments.

cadenceobjectrequired

Show properties

intervalstringrequired

Allowed:weekmonthyear

intervalCountintegerrequired

min 1

endPolicyobjectrequired

startAtstring<date-time>required

metadataMetadatarequired

Responses

200Success

dataobjectrequired

requestIdstringrequired

400Bad request, including malformed JSON

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

401Missing or invalid API key

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

409Conflict, including idempotency body drift

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

422Validation failed

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

429API key rate limit exceeded

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

defaultError

errorobjectrequired

Show properties

codestringrequired

Allowed:bad_requestunauthorizedforbiddennot_foundconflictrate_limitedvalidation_failurenot_implementedinternal_error

messagestringrequired

requestIdstring

docsUrlstring

Deep link to the errors guide section for this code.

detailsobject

Request

curl -X POST "https://api.vortex.nyc/v1/recurring-payables?environment=string&merchantAccountId=string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "sourceType": "document_payment_field",
  "sourceId": "string",
  "documentId": "string",
  "paymentFieldId": "string",
  "customerExternalId": "string",
  "billingAccountId": "string",
  "merchantAccountId": "string",
  "currency": "USD",
  "lineItems": [
    {}
  ],
  "taxMode": "not_taxable",
  "taxable": true,
  "taxBehavior": "inclusive",
  "taxClassificationKey": "standard_taxable",
  "collectionIntent": "manual",
  "feePolicy": {},
  "cadence": {
    "interval": "week",
    "intervalCount": 0
  },
  "endPolicy": {},
  "startAt": "2024-01-01T00:00:00Z",
  "metadata": {}
}'

const response = await fetch("https://api.vortex.nyc/v1/recurring-payables?environment=string&merchantAccountId=string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "sourceType": "document_payment_field",
  "sourceId": "string",
  "documentId": "string",
  "paymentFieldId": "string",
  "customerExternalId": "string",
  "billingAccountId": "string",
  "merchantAccountId": "string",
  "currency": "USD",
  "lineItems": [
    {}
  ],
  "taxMode": "not_taxable",
  "taxable": true,
  "taxBehavior": "inclusive",
  "taxClassificationKey": "standard_taxable",
  "collectionIntent": "manual",
  "feePolicy": {},
  "cadence": {
    "interval": "week",
    "intervalCount": 0
  },
  "endPolicy": {},
  "startAt": "2024-01-01T00:00:00Z",
  "metadata": {}
})
});

import requests

response = requests.post(
    "https://api.vortex.nyc/v1/recurring-payables?environment=string&merchantAccountId=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "sourceType": "document_payment_field",
  "sourceId": "string",
  "documentId": "string",
  "paymentFieldId": "string",
  "customerExternalId": "string",
  "billingAccountId": "string",
  "merchantAccountId": "string",
  "currency": "USD",
  "lineItems": [
    {}
  ],
  "taxMode": "not_taxable",
  "taxable": True,
  "taxBehavior": "inclusive",
  "taxClassificationKey": "standard_taxable",
  "collectionIntent": "manual",
  "feePolicy": {},
  "cadence": {
    "interval": "week",
    "intervalCount": 0
  },
  "endPolicy": {},
  "startAt": "2024-01-01T00:00:00Z",
  "metadata": {}
},
)

Response

{
  "data": {},
  "requestId": "string"
}