FrameSDK/com.framepayments.framesdk.transfersv2/TransferV2Requests

TransferV2Requests

Contains request payload models for the Transfers V2 API (/v2/transfers).

Types

data class Address(val line1: String? = null, val line2: String? = null, val city: String? = null, val state: String? = null, val postalCode: String? = null, val country: String? = null)

Address fields for nested payment-method billing or shipping.

AmountOnlyRequest

data class AmountOnlyRequest(val amount: TransferV2Requests.MoneyAmount? = null)

Optional amount for capture or refund.

CardPaymentMethodOptions

data class CardPaymentMethodOptions(val external3ds: TransferV2Requests.External3DS? = null)

Card options nested under payment_method_options.

CreateTransferRequest

data class CreateTransferRequest(val amount: TransferV2Requests.MoneyAmount, val source: TransferV2Requests.EndpointSlot? = null, val destination: TransferV2Requests.EndpointSlot? = null, val confirm: Boolean? = null, val authorizationMode: String? = null, val receiptEmail: String? = null, val statementDescriptor: String? = null, val productId: String? = null, val paymentLinkId: String? = null, val subscriptionId: String? = null, val invoiceId: String? = null, val description: String? = null, val reference: String? = null, val shipping: TransferV2Requests.Shipping? = null, val paymentMethodOptions: TransferV2Requests.PaymentMethodOptions? = null, val cartData: Map<String, String>? = null, val metadata: Map<String, String>? = null, val sonarSessionId: String? = null)

Body for POST /v2/transfers and shared fields for update/confirm.

EndpointSlot

data class EndpointSlot(val accountId: String? = null, val paymentMethodId: String? = null, val walletId: String? = null, val rail: String? = null, val speed: String? = null, val paymentMethod: TransferV2Requests.NestedPaymentMethod? = null)

A source or destination slot on create/update/confirm.

External3DS

data class External3DS(val version: String? = null, val transactionId: String? = null, val cryptogram: String? = null, val electronicCommerceIndicator: String? = null, val aresTransStatus: String? = null)

External 3DS cryptogram payload under payment_method_options.card.external_3ds.

MoneyAmount

data class MoneyAmount(val value: Int, val currency: String? = "usd")

Nested { value, currency } money amount for V2 create/update/confirm/capture/refund.

NestedPaymentMethod

data class NestedPaymentMethod(val accountId: String? = null, val type: String? = null, val cardNumber: String? = null, val expMonth: Int? = null, val expYear: Int? = null, val cvc: String? = null, val accountNumber: String? = null, val routingNumber: String? = null, val accountType: String? = null, val cashTag: String? = null, val email: String? = null, val phoneNumber: String? = null, val handle: String? = null, val billing: TransferV2Requests.Address? = null)

Nested payment method create payload under source / destination.

PaymentMethodOptions

data class PaymentMethodOptions(val card: TransferV2Requests.CardPaymentMethodOptions? = null)

Payment method options on create/confirm.

Shipping

data class Shipping(val line1: String? = null, val line2: String? = null, val city: String? = null, val state: String? = null, val postalCode: String? = null, val country: String? = null, val name: String? = null, val phone: String? = null, val carrier: String? = null, val trackingNumber: String? = null)

Shipping fields on create/update.