sdk/com.processout.sdk.api.model.response/POCustomerToken

POCustomerToken

@JsonClass(generateAdapter = true)

data class POCustomerToken(val id: String, @Json(name = "customer_id") val customerId: String, @Json(name = "gateway_configuration_id") val gatewayConfigurationId: String?, @Json(name = "card_id") val cardId: String?, @Json(name = "invoice_id") val invoiceId: String?, val type: String, val description: String?, @Json(name = "verification_status") val verificationStatus: String, @Json(name = "is_default") val isDefault: Boolean, @Json(name = "return_url") val returnUrl: String?, @Json(name = "cancel_url") val cancelUrl: String?, val metadata: Map<String, String>, @Json(name = "created_at") val createdAt: Date, val summary: String?, @Json(name = "is_chargeable") val isChargeable: Boolean, @Json(name = "manual_invoice_cancellation") val manualInvoiceCancellation: Boolean?, @Json(name = "can_get_balance") val canGetBalance: Boolean?)

Customer token information.

Parameters

String value that uniquely identifies this customer's token.

customerId

Customer from which the token was created.

gatewayConfigurationId

Gateway configuration that the token is linked to (which can be empty if unused).

cardId

Card used to create the token.

invoiceId

Invoice used to verify the token.

type

Source used to create the token (which will usually be a Card).

description

Description that will be sent to the tokenization gateway service.

verificationStatus

If you request verification for the token then this field tracks its status.

isDefault

Denotes whether or not this is the customer’s default token (the token used when capturing a payment using the customer’s ID as the source).

returnUrl

For APMs, this is the URL to return to the app after payment is accepted.

cancelUrl

For APMs, this is the URL to return to the app after payment is canceled.

metadata

Metadata related to the token, in the form of key-value pairs (String - String).

createdAt

Date and time when this token was created.

summary

Masked version of the payment details (for example, a card number that shows only the last 4 digits **** **** **** 4242).

isChargeable

Denotes whether or not this token is chargeable.

manualInvoiceCancellation

If true, this lets you refund or void the invoice manually after the token is verified.

canGetBalance

If true then you can find the balance for this token.

Constructors

POCustomerToken

constructor(id: String, @Json(name = "customer_id") customerId: String, @Json(name = "gateway_configuration_id") gatewayConfigurationId: String?, @Json(name = "card_id") cardId: String?, @Json(name = "invoice_id") invoiceId: String?, type: String, description: String?, @Json(name = "verification_status") verificationStatus: String, @Json(name = "is_default") isDefault: Boolean, @Json(name = "return_url") returnUrl: String?, @Json(name = "cancel_url") cancelUrl: String?, metadata: Map<String, String>, @Json(name = "created_at") createdAt: Date, summary: String?, @Json(name = "is_chargeable") isChargeable: Boolean, @Json(name = "manual_invoice_cancellation") manualInvoiceCancellation: Boolean?, @Json(name = "can_get_balance") canGetBalance: Boolean?)