Revaly HomeTrust CenterStatus
API Reference
Contact Support

Process a payment (charge)

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

Process a direct payment charge against a payment method.

This endpoint performs an immediate charge and settlement of funds. Unlike authorization, the funds are immediately captured and transferred.

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 process a payment (charge) 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

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

string
required
length ≤ 100

Merchant-provided unique identifier for this transaction

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 transaction

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

rtnData
object

Typed RTN 1.1 fraud-signal payload (customer signals only). Transaction-core fields (bin, lastFourCardNumber, purchaseAmount, purchaseCurrency, clientInitiatedDate, traceId, providerId) and the full PAN are derived by Revaly at submission time and must not be sent.

string | null

Transaction 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

Headers
string
enum
Defaults to 2.0

Selects the RAP API version for this request. New integrations should pin 2.1 (identical to 2.0 today; future refinements land there). Omit to use the base version (2.0). A value naming an unsupported version — including an empty value — returns HTTP 400; if the header is sent, it must name a supported version. See the API description for the full version policy.

Allowed:
Responses

Updated 4 days 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 4 days ago