Payment Result Types

Payment result types define the normalized response structure returned by VaultSaaS SDK operations.

PaymentResult

Normalized result returned by charge, authorize, and capture operations. Provider-specific data is available via providerMetadata.

string

VaultSaaS-normalized transaction identifier.

status

PaymentStatus

Normalized payment status across all providers.Possible values: 'completed', 'pending', 'requires_action', 'declined', 'failed', 'cancelled', 'authorized'

provider

string

Name of the provider that processed the transaction (e.g. “stripe”).

providerId

string

Provider’s own identifier for this transaction.

amount

number

Amount in smallest currency unit.

currency

string

ISO 4217 currency code.

paymentMethod

object

Snapshot of the payment method used.

Show properties

type

string

Payment method type (e.g. “card”, “pix”, “bank_transfer”).

last4

string

Last 4 digits of card number (for card payments).

brand

string

Card brand (e.g. “visa”, “mastercard”).

expiryMonth

number

Card expiration month (1-12).

expiryYear

number

Card expiration year (4 digits).

customer

object

Customer information associated with the transaction.

Show properties

string

Provider’s customer identifier.

string

Customer email address.

metadata

Record<string, string>

Merged metadata from the request and provider response.

routing

object

How the provider was selected for this transaction.

Show properties

source

'local' | 'platform'

Whether routing was performed locally or by the platform.

reason

string

Human-readable explanation of why this provider was selected.

createdAt

string

ISO 8601 timestamp of when the transaction was created.

providerMetadata

Record<string, unknown>

Raw provider-specific fields not mapped to the normalized schema.

RefundResult

Normalized result returned by a refund operation.

string

Unique refund identifier.

transactionId

string

The original transaction that was refunded.

status

'completed' | 'pending' | 'failed'

Status of the refund operation.

amount

number

Refunded amount in smallest currency unit.

currency

string

ISO 4217 currency code.

provider

string

Name of the provider that processed the refund.

providerId

string

Provider’s own identifier for this refund.

reason

string

Human-readable reason for the refund.

createdAt

string

ISO 8601 timestamp of when the refund was created.

VoidResult

Normalized result returned by a void (cancellation) operation.

string

Unique void operation identifier.

transactionId

string

The original authorized transaction that was voided.

status

'completed' | 'failed'

Status of the void operation.

provider

string

Name of the provider that processed the void.

createdAt

string

ISO 8601 timestamp of when the void was created.

TransactionStatus

Full transaction status including status history, returned by getStatus.

string

Transaction identifier.

status

PaymentStatus

Current normalized payment status.Possible values: 'completed', 'pending', 'requires_action', 'declined', 'failed', 'cancelled', 'authorized'

provider

string

Name of the provider that processed the transaction.

providerId

string

Provider’s own identifier for this transaction.

amount

number

Amount in smallest currency unit.

currency

string

ISO 4217 currency code.

history

StatusChange[]

Chronological status changes for this transaction.

Show StatusChange properties

status

PaymentStatus

The status at this point in the timeline.

timestamp

string

ISO 8601 timestamp when this status was recorded.

reason

string

Optional reason or description for the status change.

updatedAt

string

ISO 8601 timestamp of the most recent status update.

Client

Payment Operations

Types

Adapters

PaymentResult

RefundResult

VoidResult

TransactionStatus

Build docs developers (and LLMs) love

Client

Payment Operations

Types

Adapters

​PaymentResult

​RefundResult

​VoidResult

​TransactionStatus

Build docs developers (and LLMs) love

PaymentResult

RefundResult

VoidResult

TransactionStatus