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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to process a payment (charge) transaction

paymentMethodType

string | null

enum

Type of payment method to use:

creditCard: Use raw credit card details
gatewayPaymentMethodId: Use an existing gateway payment method identifier

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

Allowed:

amount

integer

required

0 to 9223372036854776000

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

merchantTransactionId

string

required

length ≤ 100

Merchant-provided unique identifier for this transaction

gatewayRoutingId

string | null

Gateway-specific token for payment processing

currency

string | null

Three-letter ISO currency code

initiatedBy

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:

mitStoredTransactionId

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

orderId

string | null

Order identifier from the merchant system

storeOnSuccess

boolean | null

Whether to store the payment method on successful transaction

bypassPlatform

boolean

Defaults to false

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

customerIp

string | null

Customer's IP address

customerId

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.

description

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

Responses

200Payment processed successfully

400Bad request - invalid parameters or request body

401Unauthorized - invalid or missing API key

403Forbidden - the authenticated principal is not permitted to perform this action

404Resource not found

422Unprocessable entity - validation succeeded but the request cannot be processed

500Internal server error

503Service unavailable - upstream dependency temporarily unavailable