moneyIn

Authorize card transaction

<Warning> This endpoint is deprecated. New integrations should use the [Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction), then capture, void, or refund the resulting transaction with the corresponding endpoints. Transactions created with this legacy endpoint must be managed with the legacy lifecycle endpoints — they aren't interchangeable with the current ones. </Warning>

Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until captured.

Only card transactions can be authorized. This endpoint can't be used for ACH transactions.

post/MoneyIn/authorize

Request

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

Query parameters

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.

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

responseTextstring required

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

isSuccessboolean required

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

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

Changes

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