Create a one-time document payable

POST/v1/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

collectionIntentstringrequired

Allowed:manual

feePolicyFeePolicyrequired

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

dueAtstring<date-time>

lineItemsPayableLineItem[]required

taxableboolean

taxBehaviorstring

Allowed:inclusiveexclusive

taxClassificationKeystring

Allowed:standard_taxable

customerTaxAddressTaxAddress

Show properties

line1stringrequired

line2string

citystringrequired

regionstringrequired

postalCodestringrequired

countrystringrequired

shipFromAddressTaxAddress

Show properties

line1stringrequired

line2string

citystringrequired

regionstringrequired

postalCodestringrequired

countrystringrequired

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/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",
  "collectionIntent": "manual",
  "feePolicy": {},
  "dueAt": "2024-01-01T00:00:00Z",
  "lineItems": [
    {}
  ],
  "taxable": true,
  "taxBehavior": "inclusive",
  "taxClassificationKey": "standard_taxable",
  "customerTaxAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "shipFromAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "metadata": {}
}'

const response = await fetch("https://api.vortex.nyc/v1/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",
  "collectionIntent": "manual",
  "feePolicy": {},
  "dueAt": "2024-01-01T00:00:00Z",
  "lineItems": [
    {}
  ],
  "taxable": true,
  "taxBehavior": "inclusive",
  "taxClassificationKey": "standard_taxable",
  "customerTaxAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "shipFromAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "metadata": {}
})
});

import requests

response = requests.post(
    "https://api.vortex.nyc/v1/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",
  "collectionIntent": "manual",
  "feePolicy": {},
  "dueAt": "2024-01-01T00:00:00Z",
  "lineItems": [
    {}
  ],
  "taxable": True,
  "taxBehavior": "inclusive",
  "taxClassificationKey": "standard_taxable",
  "customerTaxAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "shipFromAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  },
  "metadata": {}
},
)

Response

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