Make ACH Credit Transaction

Intro

API Basics

Pay In Endpoints

Pay Out Endpoints

MoneyOut
Bill

Pay Ops Endpoints

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

Object Models

Object Model References

POST

MoneyIn

makecredit

curl --request POST \
  --url https://api-sandbox.payabli.com/api/MoneyIn/makecredit \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "entrypoint": "my-entrypoint",
  "paymentMethod": {
    "method": "ach",
    "achHolder": "John Smith",
    "achRouting": "021000021",
    "achAccount": "88354454",
    "achAccountType": "Checking"
  },
  "paymentDetails": {
    "totalAmount": 1,
    "serviceFee": 0
  },
  "customerData": {
    "customerNumber": "100",
    "billingAddress1": "5127 Linkwood ave"
  }
}'

{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": {
    "authCode": null,
    "referenceId": "148-7e1528b9b7ab56d0bf3b837237b84479",
    "resultCode": 1,
    "resultText": "Approved",
    "avsResponseText": null,
    "cvvResponseText": null,
    "customerId": 100
  }
}

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.

Body

Model for the request body for a microdeposit (MakeCredit) transaction.

paymentMethod

object

required

Object describing the ACH payment method to use for transaction.

paymentDetails

object

required

The PaymentDetail object for microdeposit (MakeCredit) transactions.

customerData

object

required

Object describing the customer/payor.

customerData.customerId

integer | null

The Payabli-generated unique ID for the customer.

Example:

4440

customerData.firstName

string | null

Customer/Payor first name.

Maximum length: 250

Example:

"John"

customerData.lastName

string | null

Customer/Payor last name.

Maximum length: 250

Example:

"Doe"

customerData.company

string | null

Customer's company name.

Maximum length: 250

Example:

"Sunshine LLC"

customerData.customerNumber

string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250

Example:

"3456-7645A"

customerData.billingAddress1

string | null

Customer's billing address.

Maximum length: 250

Example:

"123 Walnut Street"

customerData.billingAddress2

string | null

Additional line for Customer's billing address.

Maximum length: 100

Example:

"STE 900"

customerData.billingCity

string | null

Customer's billing city.

Maximum length: 250

Example:

"Johnson City"

customerData.billingState

string | null

Customer's billing state. Must be 2-letter state code for address in US.

Maximum length: 250

Example:

"Johnson City"

customerData.billingZip

string | null

Customer's billing ZIP code.

Maximum length: 50

Example:

"37615"

customerData.billingCountry

string | null

Customer's billing country.

Maximum length: 100

Example:

"US"

customerData.billingPhone

string | null

Customer's phone number.

Maximum length: 50

Example:

"5555555555"

customerData.billingEmail

string | null

Customer's email address.

Maximum length: 320

Example:

"example@email.com"

customerData.shippingAddress1

string | null

The shipping address.

Maximum length: 250

Example:

"123 Walnut St"

customerData.shippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

Example:

"STE 900"

customerData.shippingCity

string | null

Shipping city.

Maximum length: 250

Example:

"Johnson City"

customerData.shippingState

string | null

Shipping state or province.

Example:

"TN"

customerData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

Example:

"37619"

customerData.shippingCountry

string | null

Shipping address country.

Maximum length: 100

Example:

"US"

customerData.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. If you are using custom identifiers, pass those in this object. Example usage:

{
  "additionalData": {
    "CustomIdentifier": "value",
    "key2": "value2",
    "key3": "value3"
  }
}

Example:

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

customerData.identifierFields

(string | null)[] | null

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

Example:

["email"]

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"

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"

accountId

string | null

Custom identifier for payment connector.

Maximum length: 250

Response

200

application/json

Success. The `referenceId` returned in a successful response is the `transId` value you need to reverse the microdeposit. A "Missing Gateway Data" message can indicate that the entrypoint targeted in the request isn't set up for ACH payments.

General response for certain moneyIn and moneyOut endpoints.

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?

Send Receipt Reverse ACH Credit

curl --request POST \
  --url https://api-sandbox.payabli.com/api/MoneyIn/makecredit \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "entrypoint": "my-entrypoint",
  "paymentMethod": {
    "method": "ach",
    "achHolder": "John Smith",
    "achRouting": "021000021",
    "achAccount": "88354454",
    "achAccountType": "Checking"
  },
  "paymentDetails": {
    "totalAmount": 1,
    "serviceFee": 0
  },
  "customerData": {
    "customerNumber": "100",
    "billingAddress1": "5127 Linkwood ave"
  }
}'

{
  "responseText": "Success",
  "isSuccess": true,
  "responseData": {
    "authCode": null,
    "referenceId": "148-7e1528b9b7ab56d0bf3b837237b84479",
    "resultCode": 1,
    "resultText": "Approved",
    "avsResponseText": null,
    "cvvResponseText": null,
    "customerId": 100
  }
}