moneyIn

Make a transaction (v2)

Make a single transaction. This method authorizes and captures a payment in one step. This is the v2 version of the api/MoneyIn/getpaid endpoint, and returns the unified response format. See Pay In unified response codes reference for more information.

post/v2/MoneyIn/getpaid

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/v2/MoneyIn/getpaid
  • Auth: HTTP bearer

Query parameters

achValidationboolean

When true, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.

When true, enables real-time validation of ACH account and routing numbers. This is an add-on feature, contact Payabli for more information.

forceCustomerCreationboolean

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

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

Headers

idempotencyKeystring

Optional but recommended. A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli; you must generate it yourself. The key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

validationCodestring

Value obtained from user when an API generated CAPTCHA is used in payment page

Request body

accountIdstring

Custom identifier for payment connector.

entryPointstring

The entrypoint identifier.

ipaddressstring

The IP address associated with the transaction.

orderDescriptionstring

Text description of the transaction.

orderIdstring

Custom identifier for the transaction.

sourcestring

Custom identifier to indicate the transaction or request source.

subdomainstring

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

subscriptionIdinteger

Payabli identifier of the subscription associated with the transaction.

Response

Ok

codestring required

Payabli's unified response code. Starts with A (Approved) or D (Declined) followed by a four-digit code that provides specific details about the transaction result. See Pay In unified response codes reference for more information.

reasonstring required

Human-readable reason corresponding to the response code.

explanationstring required

Detailed description of the response code.

actionstring required

Recommended resolution approach or next steps based on the response.

tokenstring nullable required

Pagination token (equivalent to pageIdentifier in v1 APIs). Returns null when pagination is not applicable.

Changes

No recorded changes to this operation across all 1 revision of this API.