Revaly HomeTrust CenterStatus
API Reference
Contact Support

Authorize a payment

post
https://api.revaly.co/payments/authorize

Authorize a payment without immediately capturing funds.

This endpoint creates an authorization hold on the customer's payment method. The authorized amount can later be captured using the capture endpoint.

Payment Method Types:

  • creditCard: Process using raw credit card details
  • gatewayPaymentMethodId: Process using an existing gateway payment method id

To charge a previously stored payment method, omit paymentMethodType and supply paymentMethod.paymentMethodId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request to authorize a payment transaction

string | null
enum

Type of payment method to use:

  • creditCard: Use raw credit card details
  • gatewayPaymentMethodId: Use an existing gateway payment method identifier
  • vaultToken: Use a vault-issued token (any provider). Requires paymentMethod.vaultPaymentMethod.vaultToken and paymentMethod.merchantAccountReferenceId.

To bill a stored payment method, omit this property and send paymentMethod.paymentMethodId.

Allowed:
integer
required
0 to 9223372036854776000

Authorization amount in smallest currency unit (e.g., cents for USD)

string
required
length ≤ 100

Merchant-provided unique identifier for this authorization

string | null

Gateway-specific token for payment processing

string | null

Three-letter ISO currency code

string | null
enum

Indicates who initiated the payment transaction:

  • MIT: Merchant-Initiated Transaction - Transaction initiated by the merchant without customer involvement
  • CIT: Customer-Initiated Transaction - Transaction initiated by the customer
Allowed:
string | null

Merchant-initiated transaction stored credential ID

storedCredential
object

Stored credential information for recurring, installment, or unscheduled transactions

paymentMethod
object

Payment method details for either credit card or gatewayPaymentMethodId

string | null

Order identifier from the merchant system

boolean | null

Whether to store the payment method on successful authorization

boolean
Defaults to false

When true, bypass the primary Revaly processor and execute only the fallback flow

string | null

Customer's IP address

string | null

Customer identifier

gatewayFields
object | null

Additional gateway-specific fields

rapAdditionalData
object | null

Additional data for Revaly Approval Platform optimization. Accepts any structured data that helps RAP improve approval decisions.

string | null

Authorization description

threeDS
object | null

3D Secure authentication data for payment processing

paymentPlanData
object

Payment plan and subscription information for recurring transactions

recovery
object

Recovery settings and customer recovery information

previousTransaction
object

Information about a previous transaction for reference

gateway
object

Gateway configuration and settings

Responses

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago