POST
/
MoneyOut
/
authorize
curl --request POST \
  --url https://api-sandbox.payabli.com/api/MoneyOut/authorize \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "entryPoint": "d193cf9a46",
  "subdomain": "mypage-1",
  "source": "api",
  "accountId": "<string>",
  "orderId": "O-5140",
  "orderDescription": "Depost for materials for 123 Walnut St",
  "subscriptionId": 123,
  "paymentMethod": {
    "method": "managed"
  },
  "paymentDetails": {
    "totalAmount": 100,
    "serviceFee": 0,
    "currency": "USD",
    "checkNumber": "100"
  },
  "vendorData": {
    "vendorNumber": "1234",
    "name1": "Herman'\''s Coatings and Masonry",
    "name2": "<string>",
    "ein": "12-3456789",
    "phone": "5555555555",
    "email": "example@email.com",
    "address1": "123 Ocean Drive",
    "address2": "Suite 400",
    "city": "Miami",
    "state": "FL",
    "zip": "33139",
    "country": "US",
    "mcc": "7777",
    "locationCode": "MIA123",
    "contacts": [
      {
        "contactName": "Herman Martinez",
        "contactEmail": "example@email.com",
        "contactTitle": "Owner",
        "contactPhone": "3055550000"
      }
    ],
    "billingData": {
      "id": 123,
      "bankName": "Country Bank",
      "routingAccount": "123123123",
      "accountNumber": "123123123",
      "typeAccount": "Checking",
      "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
      "bankAccountHolderType": "Business",
      "bankAccountFunction": 0
    },
    "paymentMethod": {
      "method": "managed"
    },
    "vendorStatus": 1,
    "remitAddress1": "123 Walnut Street",
    "remitAddress2": "Suite 900",
    "remitCity": "Miami",
    "remitState": "FL",
    "remitZip": "31113",
    "remitCountry": "US",
    "payeeName1": "<string>",
    "payeeName2": "<string>",
    "customerVendorAccount": "A-37622",
    "internalReferenceId": 123,
    "vendorId": "1340",
    "additionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    },
    "customField1": "<string>",
    "customField2": "<string>"
  },
  "invoiceData": [
    {
      "invoiceNumber": "INV-2345",
      "netAmount": 3762.87,
      "invoiceDate": "2024-07-01",
      "dueDate": "2024-07-01",
      "comments": "Deposit for materials",
      "AccountingField1": "MyInternalId",
      "AccountingField2": "MyInternalId",
      "AdditionalData": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      },
      "Terms": "NET30",
      "billId": 123,
      "attachments": [
        {
          "ftype": "pdf",
          "filename": "my-doc.pdf",
          "furl": "https://mysite.com/my-doc.pdf",
          "fContent": "TXkgdGVzdCBmaWxlHJ==..."
        }
      ]
    }
  ]
}'
{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": {
    "referenceId": "10-999",
    "resultCode": 1,
    "resultText": "Authorized",
    "customerId": 11234
  }
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Headers

​
idempotencyKey
string

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Example:

"6B29FC40-CA47-1067-B31D-00DD010662DA"

Query Parameters

​
forceVendorCreation
boolean
default:false

When true, the request creates a new vendor record, regardless of whether the vendor already exists.

​
allowDuplicatedBills
boolean
default:false

When true, the authorization bypasses the requirement for unique bills, identified by vendor invoice number. This allows you to make more than one payout authorization for a bill, like a split payment.

Example:

"true"

​
doNotCreateBills
boolean
default:false

When true, Payabli will not automatically create a bill for this payout transaction.

Example:

"true"

Body

Response

200
application/json

Success

The response is of type object.