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.

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?