Authorize Payout Transaction

Intro

API Basics

Pay In Endpoints

MoneyIn
Subscription
TokenStorage
Invoice
LineItem
PaymentLink
PaymentMethodDomain
HostedPaymentPages
Cloud
Wallet: Apple Pay

Pay Out Endpoints

Pay Ops Endpoints

Templates
Boarding
Chargebacks and ACH Returns
Entities
Notification
Query
Statistic
Export
Import

Object Models

Object Model References

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

forceCustomerCreation

boolean

default:false

When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.

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

entryPoint

string | null

The entrypoint identifier.

Maximum length: 50

Example:

"d193cf9a46"

subdomain

string | null

Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.

Maximum length: 50

Example:

"mypage-1"

source

string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100

Example:

"api"

accountId

string | null

Custom identifier for payment connector.

Maximum length: 250

orderId

string | null

Custom identifier for the transaction.

Maximum length: 250

Example:

"O-5140"

orderDescription

string | null

Text description of the transaction.

Maximum length: 250

Example:

"Depost for materials for 123 Walnut St"

subscriptionId

integer

Payabli identifier of the subscription associated with the transaction.

Example:

123

paymentMethod

object

Object containing details about the payment method to use for the payout.

paymentDetails

object

Object containing payment details.

vendorData

object

Object containing vendor data.

vendorData.name1

string

required

Primary name for vendor. Required for new vendor.

Example:

"Herman's Coatings and Masonry"

vendorData.ein

string

required

EIN/Tax ID for vendor.

Example:

"12-3456789"

vendorData.phone

string | null

required

Vendor's phone number. Phone number can't contain non-digit characters like hyphens or parentheses.

Example:

"5555555555"

vendorData.address1

string | null

required

Vendor's address

Example:

"123 Ocean Drive"

vendorData.city

string

required

Vendor's city.

Example:

"Miami"

vendorData.state

string

required

Vendor's state. Must be a 2 character state code.

Example:

"FL"

vendorData.zip

string

required

Vendor's zip code.

Example:

"33139"

vendorData.country

string

required

Vendor's country.

Example:

"US"

vendorData.vendorNumber

string | null

Custom number identifying the vendor. Must be unique in paypoint.

Example:

"1234"

vendorData.name2

string | null

Secondary name for vendor.

vendorData.email

string | null

Vendor's email address. Required for vCard.

Maximum length: 320

Example:

"example@email.com"

vendorData.address2

string | null

Additional line for vendor's address.

Example:

"Suite 400"

vendorData.mcc

string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

Example:

"7777"

vendorData.locationCode

string | null

Additional location code used to identify the vendor.

Example:

"MIA123"

vendorData.contacts

object[] | null

Array of objects describing the vendor's contacts.

vendorData.billingData

object

Object containing vendor's bank information.

vendorData.paymentMethod

object

Object containing details about the payment method to use for the payout.

vendorData.vendorStatus

integer | null

Vendor's status. Allowed status:

0 Inactive
1 Active

Example:

1

vendorData.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

Example:

"123 Walnut Street"

vendorData.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

Example:

"Suite 900"

vendorData.remitCity

string | null

Remittance address city. Used for mailing paper checks.

Example:

"Miami"

vendorData.remitState

string | null

Remittance address state. Used for mailing paper checks.

Example:

"FL"

vendorData.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

Example:

"31113"

vendorData.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

Example:

"US"

vendorData.payeeName1

string | null

Alternative name used to receive paper check.

vendorData.payeeName2

string | null

Alternative name used to receive paper check.

vendorData.customerVendorAccount

string | null

Account number of paypoint in the vendor side.

Example:

"A-37622"

vendorData.internalReferenceId

integer | null

Internal identifier for global vendor account.

vendorData.vendorId

integer | null

Payabli identifier for vendor record. Required when vendorNumber isn't included.

Example:

"1340"

vendorData.additionalData

object

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

vendorData.customField1

string

vendorData.customField2

string

invoiceData

object[] | null

Array of bills associated to the transaction

invoiceData.invoiceNumber

string | null

Custom number identifying the bill. Must be unique in paypoint. Required for new bill and when billId is not provided.

Maximum length: 250

Example:

"INV-2345"

invoiceData.netAmount

string | null

Net Amount owed in bill. Required when adding a bill.

Example:

3762.87

invoiceData.invoiceDate

string | null

Bill date in format YYYY-MM-DD or MM/DD/YYYY.

Example:

"2024-07-01"

invoiceData.dueDate

string | null

Bill due date in format YYYY-MM-DD or MM/DD/YYYY.

Example:

"2024-07-01"

invoiceData.comments

string | null

Any comments about bill. For managed payouts, this field has a limit of 100 characters.

Maximum length: 250

Example:

"Deposit for materials"

invoiceData.AccountingField1

string | null

Optional custom field.

Example:

"MyInternalId"

invoiceData.AccountingField2

string | null

Optional custom field.

Example:

"MyInternalId"

invoiceData.AdditionalData

string | null

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

invoiceData.Terms

string | null

Description of payment terms.

Example:

"NET30"

invoiceData.billId

integer | null

Bill ID in Payabli.

invoiceData.attachments

object[] | null

Bill image attachment. Send the bill image as Base64-encoded string, or as a publicly-accessible link. For full details on using this field with a payout authorization, see the documentation.

Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.

Response

200

application/json

Success

isSuccess

boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText

string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

pageIdentifier

string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

responseData

object | null

The object containing the response data.

Was this page helpful?

Configure Paypoint Capture Payout

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