Skip to content

Latest commit

 

History

History
8147 lines (5744 loc) · 78.5 KB

File metadata and controls

8147 lines (5744 loc) · 78.5 KB

Reference

Applications

client.applications.list() -> SyncPagingIterable<Application>

🔌 Usage

client.applications().list(
    ApplicationsListRequest
        .builder()
        .id(
            Arrays.asList("id")
        )
        .type(
            Arrays.asList("type")
        )
        .page(1)
        .start("start")
        .size(1)
        .build()
);

⚙️ Parameters

id: Optional<String>

type: Optional<String>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.applications.create(request) -> Application

🔌 Usage

client.applications().create(
    CreateApplicationRequest
        .builder()
        .name("name")
        .type("type")
        .build()
);

⚙️ Parameters

name: String

type: String

permissions: Optional<List<String>>

rules: Optional<List<AccessRule>>

createKey: Optional<Boolean>

client.applications.get(id) -> Application

🔌 Usage

client.applications().get("id");

⚙️ Parameters

id: String

client.applications.update(id, request) -> Application

🔌 Usage

client.applications().update(
    "id",
    UpdateApplicationRequest
        .builder()
        .name("name")
        .build()
);

⚙️ Parameters

id: String

name: String

permissions: Optional<List<String>>

rules: Optional<List<AccessRule>>

client.applications.delete(id)

🔌 Usage

client.applications().delete("id");

⚙️ Parameters

id: String

client.applications.getByKey() -> Application

🔌 Usage

client.applications().getByKey();

ApplicationKeys

client.applicationKeys.list(id) -> List&lt;ApplicationKey&gt;

🔌 Usage

client.applicationKeys().list(
    "id",
    ApplicationKeysListRequest
        .builder()
        .keyId(
            Arrays.asList("id")
        )
        .type(
            Arrays.asList("type")
        )
        .build()
);

⚙️ Parameters

id: String

keyId: Optional<String>

type: Optional<String>

client.applicationKeys.create(id) -> ApplicationKey

🔌 Usage

client.applicationKeys().create("id");

⚙️ Parameters

id: String

client.applicationKeys.get(id, keyId) -> ApplicationKey

🔌 Usage

client.applicationKeys().get("id", "keyId");

⚙️ Parameters

id: String

keyId: String

client.applicationKeys.delete(id, keyId)

🔌 Usage

client.applicationKeys().delete("id", "keyId");

⚙️ Parameters

id: String

keyId: String

ApplicationTemplates

client.applicationTemplates.list() -> List&lt;ApplicationTemplate&gt;

🔌 Usage

client.applicationTemplates().list();
client.applicationTemplates.get(id) -> ApplicationTemplate

🔌 Usage

client.applicationTemplates().get("id");

⚙️ Parameters

id: String

ApplePay

client.applePay.create(request) -> ApplePayCreateResponse

🔌 Usage

client.applePay().create(
    ApplePayCreateRequest
        .builder()
        .build()
);

⚙️ Parameters

expiresAt: Optional<String>

applePaymentData: Optional<ApplePayMethodToken>

merchantRegistrationId: Optional<String>

client.applePay.get(id) -> ApplePayToken

🔌 Usage

client.applePay().get("id");

⚙️ Parameters

id: String

client.applePay.delete(id) -> String

🔌 Usage

client.applePay().delete("id");

⚙️ Parameters

id: String

GooglePay

client.googlePay.create(request) -> GooglePayCreateResponse

🔌 Usage

client.googlePay().create(
    GooglePayCreateRequest
        .builder()
        .build()
);

⚙️ Parameters

expiresAt: Optional<String>

googlePaymentData: Optional<GooglePayMethodToken>

merchantRegistrationId: Optional<String>

client.googlePay.get(id) -> GooglePayToken

🔌 Usage

client.googlePay().get("id");

⚙️ Parameters

id: String

client.googlePay.delete(id) -> String

🔌 Usage

client.googlePay().delete("id");

⚙️ Parameters

id: String

Documents

client.documents.upload(request) -> Document

🔌 Usage

client.documents().upload(
    null,
    DocumentsUploadRequest
        .builder()
        .build()
);
client.documents.get(id) -> Document

🔌 Usage

client.documents().get("id");

⚙️ Parameters

id: String

client.documents.delete(id)

🔌 Usage

client.documents().delete("id");

⚙️ Parameters

id: String

Tokens

client.tokens.detokenize(request) -> Object

🔌 Usage

client.tokens().detokenize(new 
HashMap<String, Object>() {{put("key", "value");
}});

⚙️ Parameters

request: Object

client.tokens.tokenize(request) -> Object

🔌 Usage

client.tokens().tokenize(new 
HashMap<String, Object>() {{put("key", "value");
}});

⚙️ Parameters

request: Object

client.tokens.get(id) -> Token

🔌 Usage

client.tokens().get("id");

⚙️ Parameters

id: String

client.tokens.delete(id)

🔌 Usage

client.tokens().delete("id");

⚙️ Parameters

id: String

client.tokens.update(id, request) -> Token

🔌 Usage

client.tokens().update(
    "id",
    UpdateTokenRequest
        .builder()
        .build()
);

⚙️ Parameters

id: String

data: Optional<Object>

privacy: Optional<UpdatePrivacy>

metadata: Optional<Map<String, Optional<String>>>

searchIndexes: Optional<List<String>>

fingerprintExpression: Optional<String>

mask: Optional<Object>

expiresAt: Optional<String>

deduplicateToken: Optional<Boolean>

containers: Optional<List<String>>

client.tokens.create(request) -> Token

🔌 Usage

client.tokens().create(
    CreateTokenRequest
        .builder()
        .build()
);

⚙️ Parameters

request: CreateTokenRequest

client.tokens.listV2() -> SyncPagingIterable&lt;Token&gt;

🔌 Usage

client.tokens().listV2(
    TokensListV2Request
        .builder()
        .type("type")
        .container("container")
        .fingerprint("fingerprint")
        .start("start")
        .size(1)
        .build()
);

⚙️ Parameters

type: Optional<String>

container: Optional<String>

fingerprint: Optional<String>

metadata: Optional<Map<String, Optional<String>>>

start: Optional<String>

size: Optional<Integer>

client.tokens.searchV2(request) -> SyncPagingIterable&lt;Token&gt;

🔌 Usage

client.tokens().searchV2(
    SearchTokensRequestV2
        .builder()
        .build()
);

⚙️ Parameters

query: Optional<String>

start: Optional<String>

size: Optional<Integer>

Enrichments

client.enrichments.bankAccountVerify(request) -> BankVerificationResponse

🔌 Usage

client.enrichments().bankAccountVerify(
    BankVerificationRequest
        .builder()
        .tokenId("token_id")
        .build()
);

⚙️ Parameters

tokenId: String

countryCode: Optional<String>

routingNumber: Optional<String>

client.enrichments.cardDetails() -> CardDetailsResponse

🔌 Usage

client.enrichments().cardDetails(
    EnrichmentsCardDetailsRequest
        .builder()
        .bin("bin")
        .build()
);

⚙️ Parameters

bin: String

Keys

client.keys.list() -> List&lt;ClientEncryptionKeyMetadataResponse&gt;

🔌 Usage

client.keys().list();
client.keys.create(request) -> ClientEncryptionKeyResponse

🔌 Usage

client.keys().create(
    ClientEncryptionKeyRequest
        .builder()
        .build()
);

⚙️ Parameters

expiresAt: Optional<OffsetDateTime>

client.keys.get(id) -> ClientEncryptionKeyMetadataResponse

🔌 Usage

client.keys().get("id");

⚙️ Parameters

id: String

client.keys.delete(id)

🔌 Usage

client.keys().delete("id");

⚙️ Parameters

id: String

Logs

client.logs.list() -> SyncPagingIterable&lt;Log&gt;

🔌 Usage

client.logs().list(
    LogsListRequest
        .builder()
        .entityType("entity_type")
        .entityId("entity_id")
        .startDate(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .endDate(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .page(1)
        .start("start")
        .size(1)
        .build()
);

⚙️ Parameters

entityType: Optional<String>

entityId: Optional<String>

startDate: Optional<OffsetDateTime>

endDate: Optional<OffsetDateTime>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.logs.getEntityTypes() -> List&lt;LogEntityType&gt;

🔌 Usage

client.logs().getEntityTypes();

NetworkTokens

client.networkTokens.create(request) -> NetworkToken

🔌 Usage

client.networkTokens().create(
    CreateNetworkTokenRequest
        .builder()
        .build()
);

⚙️ Parameters

data: Optional<Card>

tokenId: Optional<String>

tokenIntentId: Optional<String>

expirationMonth: Optional<Integer>

expirationYear: Optional<Integer>

cardholderInfo: Optional<CardholderInfo>

merchantId: Optional<String>

client.networkTokens.cryptogram(id) -> NetworkTokenCryptogram

🔌 Usage

client.networkTokens().cryptogram("id");

⚙️ Parameters

id: String

client.networkTokens.get(id) -> NetworkToken

🔌 Usage

client.networkTokens().get("id");

⚙️ Parameters

id: String

client.networkTokens.delete(id)

🔌 Usage

client.networkTokens().delete("id");

⚙️ Parameters

id: String

client.networkTokens.suspend(id) -> NetworkToken

🔌 Usage

client.networkTokens().suspend("id");

⚙️ Parameters

id: String

client.networkTokens.resume(id) -> NetworkToken

🔌 Usage

client.networkTokens().resume("id");

⚙️ Parameters

id: String

Permissions

client.permissions.list() -> List&lt;Permission&gt;

🔌 Usage

client.permissions().list(
    PermissionsListRequest
        .builder()
        .applicationType("application_type")
        .build()
);

⚙️ Parameters

applicationType: Optional<String>

Proxies

client.proxies.list() -> SyncPagingIterable&lt;Proxy&gt;

🔌 Usage

client.proxies().list(
    ProxiesListRequest
        .builder()
        .id(
            Arrays.asList("id")
        )
        .name("name")
        .page(1)
        .start("start")
        .size(1)
        .build()
);

⚙️ Parameters

id: Optional<String>

name: Optional<String>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.proxies.create(request) -> Proxy

🔌 Usage

client.proxies().create(
    CreateProxyRequest
        .builder()
        .name("name")
        .destinationUrl("destination_url")
        .build()
);

⚙️ Parameters

name: String

destinationUrl: String

requestReactorId: Optional<String>

responseReactorId: Optional<String>

requestTransform: Optional<ProxyTransform>

responseTransform: Optional<ProxyTransform>

requestTransforms: Optional<List<ProxyTransform>>

responseTransforms: Optional<List<ProxyTransform>>

application: Optional<Application>

configuration: Optional<Map<String, Optional<String>>>

requireAuth: Optional<Boolean>

disableDetokenization: Optional<Boolean>

client.proxies.get(id) -> Proxy

🔌 Usage

client.proxies().get("id");

⚙️ Parameters

id: String

client.proxies.update(id, request) -> Proxy

🔌 Usage

client.proxies().update(
    "id",
    UpdateProxyRequest
        .builder()
        .name("name")
        .destinationUrl("destination_url")
        .build()
);

⚙️ Parameters

id: String

name: String

destinationUrl: String

requestReactorId: Optional<String>

responseReactorId: Optional<String>

requestTransform: Optional<ProxyTransform>

responseTransform: Optional<ProxyTransform>

requestTransforms: Optional<List<ProxyTransform>>

responseTransforms: Optional<List<ProxyTransform>>

application: Optional<Application>

configuration: Optional<Map<String, Optional<String>>>

requireAuth: Optional<Boolean>

disableDetokenization: Optional<Boolean>

client.proxies.delete(id)

🔌 Usage

client.proxies().delete("id");

⚙️ Parameters

id: String

client.proxies.patch(id, request)

🔌 Usage

client.proxies().patch(
    "id",
    PatchProxyRequest
        .builder()
        .build()
);

⚙️ Parameters

id: String

name: Optional<String>

destinationUrl: Optional<String>

requestTransform: Optional<ProxyTransform>

responseTransform: Optional<ProxyTransform>

requestTransforms: Optional<List<ProxyTransform>>

responseTransforms: Optional<List<ProxyTransform>>

application: Optional<Application>

configuration: Optional<Map<String, Optional<String>>>

requireAuth: Optional<Boolean>

disableDetokenization: Optional<Boolean>

Reactors

client.reactors.list() -> SyncPagingIterable&lt;Reactor&gt;

🔌 Usage

client.reactors().list(
    ReactorsListRequest
        .builder()
        .id(
            Arrays.asList("id")
        )
        .name("name")
        .page(1)
        .start("start")
        .size(1)
        .build()
);

⚙️ Parameters

id: Optional<String>

name: Optional<String>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.reactors.create(request) -> Reactor

🔌 Usage

client.reactors().create(
    CreateReactorRequest
        .builder()
        .name("name")
        .code("code")
        .build()
);

⚙️ Parameters

name: String

code: String

application: Optional<Application>

configuration: Optional<Map<String, Optional<String>>>

runtime: Optional<ReactorRuntime>

client.reactors.get(id) -> Reactor

🔌 Usage

client.reactors().get("id");

⚙️ Parameters

id: String

client.reactors.update(id, request) -> Reactor

🔌 Usage

client.reactors().update(
    "id",
    UpdateReactorRequest
        .builder()
        .name("name")
        .code("code")
        .build()
);

⚙️ Parameters

id: String

name: String

application: Optional<Application>

code: String

configuration: Optional<Map<String, Optional<String>>>

runtime: Optional<ReactorRuntime>

client.reactors.delete(id)

🔌 Usage

client.reactors().delete("id");

⚙️ Parameters

id: String

client.reactors.patch(id, request)

🔌 Usage

client.reactors().patch(
    "id",
    PatchReactorRequest
        .builder()
        .build()
);

⚙️ Parameters

id: String

name: Optional<String>

application: Optional<Application>

code: Optional<String>

configuration: Optional<Map<String, Optional<String>>>

runtime: Optional<ReactorRuntime>

client.reactors.react(id, request) -> ReactResponse

🔌 Usage

client.reactors().react("id", new 
HashMap<String, Object>() {{put("key", "value");
}});

⚙️ Parameters

id: String

request: Object

client.reactors.reactAsync(id, request) -> AsyncReactResponse

🔌 Usage

client.reactors().reactAsync("id", new 
HashMap<String, Object>() {{put("key", "value");
}});

⚙️ Parameters

id: String

request: Object

Roles

client.roles.list() -> List&lt;Role&gt;

🔌 Usage

client.roles().list();

Sessions

client.sessions.create() -> CreateSessionResponse

🔌 Usage

client.sessions().create();
client.sessions.authorize(request)

🔌 Usage

client.sessions().authorize(
    AuthorizeSessionRequest
        .builder()
        .nonce("nonce")
        .build()
);

⚙️ Parameters

nonce: String

expiresAt: Optional<String>

permissions: Optional<List<String>>

rules: Optional<List<AccessRule>>

TokenIntents

client.tokenIntents.get(id) -> TokenIntent

🔌 Usage

client.tokenIntents().get("id");

⚙️ Parameters

id: String

client.tokenIntents.delete(id)

🔌 Usage

client.tokenIntents().delete("id");

⚙️ Parameters

id: String

client.tokenIntents.create(request) -> CreateTokenIntentResponse

🔌 Usage

client.tokenIntents().create(
    CreateTokenIntentRequest
        .builder()
        .type("type")
        .build()
);

⚙️ Parameters

type: String

data: Optional<Object>

encrypted: Optional<String>

Webhooks

client.webhooks.ping()

📝 Description

Simple endpoint that can be utilized to verify the application is running

🔌 Usage

client.webhooks().ping();
client.webhooks.get(id) -> Webhook

📝 Description

Returns the webhook

🔌 Usage

client.webhooks().get("id");

⚙️ Parameters

id: String

client.webhooks.update(id, request) -> Webhook

📝 Description

Update a new webhook

🔌 Usage

client.webhooks().update(
    "id",
    UpdateWebhookRequest
        .builder()
        .name("webhook-update")
        .url("http://www.example.com")
        .events(
            Arrays.asList("token:created")
        )
        .build()
);

⚙️ Parameters

id: String

name: String — The name of the webhook

url: String — The URL to which the webhook will send events

notifyEmail: Optional<String> — The email address to use for management notification events. Ie: webhook disabled

events: List<String> — An array of event types that the webhook will listen for

client.webhooks.delete(id)

📝 Description

Delete a new webhook

🔌 Usage

client.webhooks().delete("id");

⚙️ Parameters

id: String

client.webhooks.list() -> WebhookList

📝 Description

Returns the configured webhooks

🔌 Usage

client.webhooks().list();
client.webhooks.create(request) -> Webhook

📝 Description

Create a new webhook

🔌 Usage

client.webhooks().create(
    CreateWebhookRequest
        .builder()
        .name("webhook-create")
        .url("http://www.example.com")
        .events(
            Arrays.asList("token:created")
        )
        .build()
);

⚙️ Parameters

name: String — The name of the webhook

url: String — The URL to which the webhook will send events

notifyEmail: Optional<String> — The email address to use for management notification events. Ie: webhook disabled

events: List<String> — An array of event types that the webhook will listen for

AccountUpdater Jobs

client.accountUpdater.jobs.get(id) -> AccountUpdaterJob

📝 Description

Returns the account updater batch job

🔌 Usage

client.accountUpdater().jobs().get("id");

⚙️ Parameters

id: String

client.accountUpdater.jobs.list() -> AccountUpdaterJobList

📝 Description

Returns a list of account updater batch jobs

🔌 Usage

client.accountUpdater().jobs().list(
    JobsListRequest
        .builder()
        .size(1)
        .start("start")
        .build()
);

⚙️ Parameters

size: Optional<Integer> — The maximum number of jobs to return

start: Optional<String> — Cursor for pagination

client.accountUpdater.jobs.create(request) -> AccountUpdaterJob

📝 Description

Returns the created account updater batch job

🔌 Usage

client.accountUpdater().jobs().create(
    CreateAccountUpdaterJobRequest
        .builder()
        .build()
);

⚙️ Parameters

deduplicateTokens: Optional<Boolean> — Whether deduplication should be enabled when creating new tokens. Uses the value of the Deduplicate Tokens setting on the tenant if not set.

merchantId: Optional<String> — Tenant merchant identifier

resultVersion: Optional<CreateAccountUpdaterJobRequestResultVersion> — Version of the result CSV format. Version '1' returns base columns. Version '1.1' adds new_fingerprint and new_brand columns. Version '1.2' adds the new_last4 column on top of 1.1.

AccountUpdater RealTime

client.accountUpdater.realTime.invoke(request) -> AccountUpdaterRealTimeResponse

📝 Description

Returns the update result

🔌 Usage

client.accountUpdater().realTime().invoke(
    AccountUpdaterRealTimeRequest
        .builder()
        .tokenId("9a420b15-ddfe-4793-9466-48f53520e47c")
        .build()
);

⚙️ Parameters

tokenId: String — Card Token identifier

expirationYear: Optional<Integer> — The 4-digit expiration year of the account number. Not required if the card token already stores this value.

expirationMonth: Optional<Integer> — The 2-digit expiration month of the account number. Not required if the card token already stores this value.

deduplicateToken: Optional<Boolean> — Whether deduplication should be enabled when creating the new token. Uses the value of the Deduplicate Tokens setting on the tenant if not set.

merchantId: Optional<String> — Tenant merchant identifier

Agentic Agents

client.agentic.agents.create(request) -> Agent

🔌 Usage

client.agentic().agents().create(
    CreateAgentRequest
        .builder()
        .name("name")
        .build()
);

⚙️ Parameters

name: String

enrollmentIds: Optional<List<String>>

instanceDetails: Optional<InstanceDetails>

client.agentic.agents.get(agentId) -> Agent

🔌 Usage

client.agentic().agents().get("agent_id");

⚙️ Parameters

agentId: String

client.agentic.agents.delete(agentId)

🔌 Usage

client.agentic().agents().delete("agent_id");

⚙️ Parameters

agentId: String

client.agentic.agents.update(agentId, request) -> Agent

🔌 Usage

client.agentic().agents().update(
    "agent_id",
    UpdateAgentRequest
        .builder()
        .build()
);

⚙️ Parameters

agentId: String

name: Optional<String>

enrollmentIds: Optional<List<String>>

instanceDetails: Optional<InstanceDetails>

Agentic Enrollments

client.agentic.enrollments.list() -> SyncPagingIterable&lt;Enrollment&gt;

📝 Description

List all enrollments for the current tenant with cursor-based pagination.

🔌 Usage

client.agentic().enrollments().list(
    EnrollmentsListRequest
        .builder()
        .limit(1)
        .cursor("cursor")
        .build()
);

⚙️ Parameters

limit: Optional<Integer>

cursor: Optional<String> — Pagination cursor from a previous response

client.agentic.enrollments.create(request) -> Enrollment

📝 Description

Enroll a card token with a card network (Visa or Mastercard).

🔌 Usage

client.agentic().enrollments().create(
    CreateEnrollmentRequest
        .builder()
        .tokenId("token_id")
        .consumer(
            Consumer
                .builder()
                .email("email")
                .build()
        )
        .build()
);

⚙️ Parameters

tokenId: String

consumer: Consumer

agentId: Optional<String> — Single agent ID (mutually exclusive with agent_ids)

agentIds: Optional<List<String>> — Multiple agent IDs (mutually exclusive with agent_id)

walletName: Optional<String> — Display label shown to the cardholder during Mastercard managed-authentication challenges. Defaults to "Agent Wallet" when not provided.

type: Optional<CreateEnrollmentRequestType>

Enrollment type. agentic (default) enrolls the card for agent-driven payments and requires verification. autofill enrolls the card for direct autofill credential retrieval, skips verification, and is currently available to test tenants only. spt enrolls the card for shared payment tokens, requires provider to be set, skips verification, and activates immediately.

provider: Optional<String> — Token provider for spt enrollments. Required when type is spt; not allowed otherwise.

client.agentic.enrollments.get(enrollmentId) -> Enrollment

🔌 Usage

client.agentic().enrollments().get("enrollment_id");

⚙️ Parameters

enrollmentId: String

client.agentic.enrollments.delete(enrollmentId)

📝 Description

Soft-deletes the enrollment by marking its status as deleted.

🔌 Usage

client.agentic().enrollments().delete("enrollment_id");

⚙️ Parameters

enrollmentId: String

client.agentic.enrollments.retry(enrollmentId) -> Enrollment

📝 Description

Retry enrolling a card that previously failed. Only failed enrollments can be retried.

🔌 Usage

client.agentic().enrollments().retry("enrollment_id");

⚙️ Parameters

enrollmentId: String

Agentic Agents Instructions

client.agentic.agents.instructions.list(agentId) -> SyncPagingIterable&lt;Instruction&gt;

📝 Description

List all purchase instructions for an agent with cursor-based pagination and optional enrollment filter.

🔌 Usage

client.agentic().agents().instructions().list(
    "agent_id",
    InstructionsListRequest
        .builder()
        .enrollmentId("enrollment_id")
        .limit(1)
        .cursor("cursor")
        .build()
);

⚙️ Parameters

agentId: String

enrollmentId: Optional<String> — Filter instructions by enrollment ID

limit: Optional<Integer>

cursor: Optional<String> — Pagination cursor from a previous response

client.agentic.agents.instructions.create(agentId, request) -> Instruction

📝 Description

Create a new payment instruction for an agent, linked to an enrollment.

🔌 Usage

client.agentic().agents().instructions().create(
    "agent_id",
    CreateInstructionRequest
        .builder()
        .enrollmentId("enrollment_id")
        .amount(
            Amount
                .builder()
                .value("100.00")
                .build()
        )
        .description("description")
        .expiresAt(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .build()
);

⚙️ Parameters

agentId: String

enrollmentId: String

amount: Amount

description: String

expiresAt: OffsetDateTime

assuranceData: Optional<Map<String, Object>>

recurring: Optional<Recurring>

instanceDetails: Optional<InstanceDetails>

networkBusinessProfile: Optional<String>

Stripe network business profile identifier (profile_...) of the seller allowed to use the shared payment token. Maps to Stripe's seller_details[network_business_profile]. Only valid for spt (Stripe) enrollments; required unless an MPP challenge with Stripe network details is provided.

mpp: Optional<CreateInstructionRequestMpp>

MPP mode — provide the merchant's MPP challenge to receive an MPP credential from the credentials endpoint instead of a raw shared payment token ID. The challenge must carry Stripe values (method: stripe). Only valid for spt (Stripe) enrollments.

client.agentic.agents.instructions.get(agentId, instructionId) -> Instruction

🔌 Usage

client.agentic().agents().instructions().get("agent_id", "instruction_id");

⚙️ Parameters

agentId: String

instructionId: String

client.agentic.agents.instructions.delete(agentId, instructionId)

🔌 Usage

client.agentic().agents().instructions().delete("agent_id", "instruction_id");

⚙️ Parameters

agentId: String

instructionId: String

client.agentic.agents.instructions.update(agentId, instructionId, request) -> Instruction

🔌 Usage

client.agentic().agents().instructions().update(
    "agent_id",
    "instruction_id",
    UpdateInstructionRequest
        .builder()
        .build()
);

⚙️ Parameters

agentId: String

instructionId: String

amount: Optional<Amount>

description: Optional<String>

expiresAt: Optional<OffsetDateTime>

Agentic Agents Instructions Credentials

client.agentic.agents.instructions.credentials.create(agentId, instructionId, request) -> Credentials

📝 Description

Retrieve payment credentials (card number, expiration, CVC) for a purchase instruction.

🔌 Usage

client.agentic().agents().instructions().credentials().create(
    "agent_id",
    "instruction_id",
    GetCredentialsRequest
        .builder()
        .build()
);

⚙️ Parameters

agentId: String

instructionId: String

products: Optional<List<Product>>

merchant: Optional<AgenticMerchant>

Required for card (Visa/Mastercard) instructions unless provided at instruction creation. Not used for spt instructions.

amount: Optional<Amount>

deliveryMethod: Optional<DeliveryMethod>

shippingAddress: Optional<ShippingAddress>

Agentic Agents Instructions Verify

client.agentic.agents.instructions.verify.start(agentId, instructionId, request) -> VerificationResponse

📝 Description

Initiate cardholder verification for a purchase instruction that requires it.

🔌 Usage

client.agentic().agents().instructions().verify().start(
    "agent_id",
    "instruction_id",
    StartVerificationRequest
        .builder()
        .deviceContext(
            DeviceContext
                .builder()
                .screenHeight(1)
                .screenWidth(1)
                .userAgentString("user_agent_string")
                .languageCode("language_code")
                .timeZone("time_zone")
                .javaScriptEnabled(true)
                .clientDeviceId("client_device_id")
                .clientReferenceId("client_reference_id")
                .platformType(DeviceContextPlatformType.WEB)
                .build()
        )
        .build()
);

⚙️ Parameters

agentId: String

instructionId: String

request: StartVerificationRequest

client.agentic.agents.instructions.verify.passkey(agentId, instructionId, request) -> Instruction

📝 Description

Submit passkey/FIDO assertion data to complete instruction verification.

🔌 Usage

client.agentic().agents().instructions().verify().passkey(
    "agent_id",
    "instruction_id",
    SubmitPasskeyRequest
        .builder()
        .assuranceData(
            new HashMap<String, Object>() {{
                put("key", "value");
            }}
        )
        .build()
);

⚙️ Parameters

agentId: String

instructionId: String

assuranceData: Map<String, Object> — Visa format (identifier, dfp_session_id, fido_assertion_data) or Mastercard format (flexible object)

srcCorrelationId: Optional<String>

flowId: Optional<String>

Agentic Enrollments Verify

client.agentic.enrollments.verify.start(enrollmentId, request) -> VerificationResponse

📝 Description

Initiates the cardholder verification flow for a pending enrollment.

🔌 Usage

client.agentic().enrollments().verify().start(
    "enrollment_id",
    StartVerificationRequest
        .builder()
        .deviceContext(
            DeviceContext
                .builder()
                .screenHeight(1)
                .screenWidth(1)
                .userAgentString("user_agent_string")
                .languageCode("language_code")
                .timeZone("time_zone")
                .javaScriptEnabled(true)
                .clientDeviceId("client_device_id")
                .clientReferenceId("client_reference_id")
                .platformType(DeviceContextPlatformType.WEB)
                .build()
        )
        .build()
);

⚙️ Parameters

enrollmentId: String

request: StartVerificationRequest

client.agentic.enrollments.verify.method(enrollmentId, request) -> VerificationResponse

📝 Description

Choose the OTP delivery method (SMS, email, etc.) for enrollment verification.

🔌 Usage

client.agentic().enrollments().verify().method(
    "enrollment_id",
    SelectMethodRequest
        .builder()
        .methodId("method_id")
        .build()
);

⚙️ Parameters

enrollmentId: String

methodId: String

client.agentic.enrollments.verify.otp(enrollmentId, request) -> VerificationResponse

📝 Description

Submit the one-time password received by the cardholder.

🔌 Usage

client.agentic().enrollments().verify().otp(
    "enrollment_id",
    SubmitOtpRequest
        .builder()
        .otpCode("otp_code")
        .build()
);

⚙️ Parameters

enrollmentId: String

otpCode: String

client.agentic.enrollments.verify.complete(enrollmentId, request) -> VerificationResponse

📝 Description

Complete the verification flow (e.g. after passkey creation). Body is optional — Visa sends empty body, Mastercard sends assurance_data.

🔌 Usage

client.agentic().enrollments().verify().complete(
    "enrollment_id",
    CompleteVerificationRequest
        .builder()
        .build()
);

⚙️ Parameters

enrollmentId: String

assuranceData: Optional<Map<String, Object>>

srcCorrelationId: Optional<String>

ApplePay Merchant

client.applePay.merchant.get(id) -> ApplePayMerchant

🔌 Usage

client.applePay().merchant().get("id");

⚙️ Parameters

id: String

client.applePay.merchant.delete(id)

🔌 Usage

client.applePay().merchant().delete("id");

⚙️ Parameters

id: String

client.applePay.merchant.create(request) -> ApplePayMerchant

🔌 Usage

client.applePay().merchant().create(
    ApplePayMerchantRegisterRequest
        .builder()
        .build()
);

⚙️ Parameters

merchantIdentifier: Optional<String>

ApplePay Domain

client.applePay.domain.deregister(request)

🔌 Usage

client.applePay().domain().deregister(
    ApplePayDomainDeregistrationRequest
        .builder()
        .domain("domain")
        .build()
);

⚙️ Parameters

domain: String

client.applePay.domain.get() -> ApplePayDomainRegistrationResponse

🔌 Usage

client.applePay().domain().get();
client.applePay.domain.register(request) -> ApplePayDomainRegistrationResponse

🔌 Usage

client.applePay().domain().register(
    ApplePayDomainRegistrationRequest
        .builder()
        .domain("domain")
        .build()
);

⚙️ Parameters

domain: String

client.applePay.domain.registerAll(request) -> ApplePayDomainRegistrationResponse

🔌 Usage

client.applePay().domain().registerAll(
    ApplePayDomainRegistrationListRequest
        .builder()
        .build()
);

⚙️ Parameters

domains: Optional<List<String>>

ApplePay Session

client.applePay.session.create(request) -> String

🔌 Usage

client.applePay().session().create(
    ApplePaySessionRequest
        .builder()
        .build()
);

⚙️ Parameters

validationUrl: Optional<String>

displayName: Optional<String>

domain: Optional<String>

merchantRegistrationId: Optional<String>

ApplePay Merchant Certificates

client.applePay.merchant.certificates.get(merchantId, id) -> ApplePayMerchantCertificates

🔌 Usage

client.applePay().merchant().certificates().get("merchantId", "id");

⚙️ Parameters

merchantId: String

id: String

client.applePay.merchant.certificates.delete(merchantId, id)

🔌 Usage

client.applePay().merchant().certificates().delete("merchantId", "id");

⚙️ Parameters

merchantId: String

id: String

client.applePay.merchant.certificates.create(merchantId, request) -> ApplePayMerchantCertificates

🔌 Usage

client.applePay().merchant().certificates().create(
    "merchantId",
    ApplePayMerchantCertificatesRegisterRequest
        .builder()
        .paymentProcessorCertificateData("payment_processor_certificate_data")
        .paymentProcessorCertificatePassword("payment_processor_certificate_password")
        .build()
);

⚙️ Parameters

merchantId: String

merchantCertificateData: Optional<String>

merchantCertificatePassword: Optional<String>

paymentProcessorCertificateData: String

paymentProcessorCertificatePassword: String

domain: Optional<String>

Documents Data

client.documents.data.get(documentId) -> InputStream

🔌 Usage

client.documents().data().get("documentId");

⚙️ Parameters

documentId: String

GooglePay Merchant

client.googlePay.merchant.get(id) -> GooglePayMerchant

🔌 Usage

client.googlePay().merchant().get("id");

⚙️ Parameters

id: String

client.googlePay.merchant.delete(id)

🔌 Usage

client.googlePay().merchant().delete("id");

⚙️ Parameters

id: String

client.googlePay.merchant.create(request) -> GooglePayMerchant

🔌 Usage

client.googlePay().merchant().create(
    GooglePayMerchantRegisterRequest
        .builder()
        .build()
);

⚙️ Parameters

merchantIdentifier: Optional<String>

GooglePay Merchant Certificates

client.googlePay.merchant.certificates.get(merchantId, id) -> GooglePayMerchantCertificates

🔌 Usage

client.googlePay().merchant().certificates().get("merchantId", "id");

⚙️ Parameters

merchantId: String

id: String

client.googlePay.merchant.certificates.delete(merchantId, id)

🔌 Usage

client.googlePay().merchant().certificates().delete("merchantId", "id");

⚙️ Parameters

merchantId: String

id: String

client.googlePay.merchant.certificates.create(merchantId, request) -> GooglePayMerchantCertificates

🔌 Usage

client.googlePay().merchant().certificates().create(
    "merchantId",
    GooglePayMerchantCertificatesRegisterRequest
        .builder()
        .build()
);

⚙️ Parameters

merchantId: String

merchantCertificateData: Optional<String>

merchantCertificatePassword: Optional<String>

NetworkTokens Account

client.networkTokens.account.get(id) -> NetworkTokenAccount

🔌 Usage

client.networkTokens().account().get("id");

⚙️ Parameters

id: String

Reactors Results

client.reactors.results.get(id, requestId) -> Object

🔌 Usage

client.reactors().results().get("id", "requestId");

⚙️ Parameters

id: String

requestId: String

Tenants SecurityContact

client.tenants.securityContact.get() -> SecurityContactEmailResponse

🔌 Usage

client.tenants().securityContact().get();
client.tenants.securityContact.update(request) -> SecurityContactEmailResponse

🔌 Usage

client.tenants().securityContact().update(
    SecurityContactEmailRequest
        .builder()
        .email("email")
        .build()
);

⚙️ Parameters

email: String

Tenants Connections

client.tenants.connections.create(request) -> CreateTenantConnectionResponse

🔌 Usage

client.tenants().connections().create(
    CreateTenantConnectionRequest
        .builder()
        .strategy("strategy")
        .options(
            TenantConnectionOptions
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

strategy: String

options: TenantConnectionOptions

client.tenants.connections.delete()

🔌 Usage

client.tenants().connections().delete();

Tenants Invitations

client.tenants.invitations.list() -> SyncPagingIterable&lt;TenantInvitationResponse&gt;

🔌 Usage

client.tenants().invitations().list(
    InvitationsListRequest
        .builder()
        .status(TenantInvitationStatus.PENDING)
        .page(1)
        .start("start")
        .size(1)
        .build()
);

⚙️ Parameters

status: Optional<TenantInvitationStatus>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.tenants.invitations.create(request) -> TenantInvitationResponse

🔌 Usage

client.tenants().invitations().create(
    CreateTenantInvitationRequest
        .builder()
        .email("email")
        .build()
);

⚙️ Parameters

email: String

role: Optional<String>

client.tenants.invitations.resend(invitationId) -> TenantInvitationResponse

🔌 Usage

client.tenants().invitations().resend("invitationId");

⚙️ Parameters

invitationId: String

client.tenants.invitations.get(invitationId) -> TenantInvitationResponse

🔌 Usage

client.tenants().invitations().get("invitationId");

⚙️ Parameters

invitationId: String

client.tenants.invitations.delete(invitationId)

🔌 Usage

client.tenants().invitations().delete("invitationId");

⚙️ Parameters

invitationId: String

Tenants Members

client.tenants.members.list() -> SyncPagingIterable&lt;TenantMemberResponse&gt;

🔌 Usage

client.tenants().members().list(
    MembersListRequest
        .builder()
        .userId(
            Arrays.asList("user_id")
        )
        .page(1)
        .start("start")
        .size(1)
        .build()
);

⚙️ Parameters

userId: Optional<String>

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.tenants.members.update(memberId, request) -> TenantMemberResponse

🔌 Usage

client.tenants().members().update(
    "memberId",
    UpdateTenantMemberRequest
        .builder()
        .role("role")
        .build()
);

⚙️ Parameters

memberId: String

role: String

client.tenants.members.delete(memberId)

🔌 Usage

client.tenants().members().delete("memberId");

⚙️ Parameters

memberId: String

Tenants Merchants

client.tenants.merchants.list(tenantId) -> SyncPagingIterable&lt;TenantMerchant&gt;

🔌 Usage

client.tenants().merchants().list(
    "tenantId",
    MerchantsListRequest
        .builder()
        .page(1)
        .start("start")
        .size(1)
        .build()
);

⚙️ Parameters

tenantId: String

page: Optional<Integer>

start: Optional<String>

size: Optional<Integer>

client.tenants.merchants.create(tenantId, request) -> TenantMerchant

🔌 Usage

client.tenants().merchants().create(
    "tenantId",
    TenantMerchantRequest
        .builder()
        .name("name")
        .details(
            MerchantDetails
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

tenantId: String

request: TenantMerchantRequest

client.tenants.merchants.get(tenantId, merchantId) -> TenantMerchant

🔌 Usage

client.tenants().merchants().get("tenantId", "merchantId");

⚙️ Parameters

tenantId: String

merchantId: String

client.tenants.merchants.delete(tenantId, merchantId) -> TenantMerchant

🔌 Usage

client.tenants().merchants().delete("tenantId", "merchantId");

⚙️ Parameters

tenantId: String

merchantId: String

client.tenants.merchants.update(tenantId, merchantId, request) -> TenantMerchant

🔌 Usage

client.tenants().merchants().update(
    "tenantId",
    "merchantId",
    TenantMerchantRequest
        .builder()
        .name("name")
        .details(
            MerchantDetails
                .builder()
                .build()
        )
        .build()
);

⚙️ Parameters

tenantId: String

merchantId: String

request: TenantMerchantRequest

client.tenants.merchants.requestOnboarding(tenantId, merchantId, request) -> TenantMerchant

🔌 Usage

client.tenants().merchants().requestOnboarding(
    "tenantId",
    "merchantId",
    ServiceOnboardingRequest
        .builder()
        .build()
);

⚙️ Parameters

tenantId: String

merchantId: String

accountUpdater: Optional<List<String>>

networkToken: Optional<List<String>>

agenticCommerce: Optional<List<String>>

cardNetworkInfo: Optional<CardNetworkInfo>

Tenants Owner

client.tenants.owner.get() -> TenantMemberResponse

🔌 Usage

client.tenants().owner().get();
client.tenants.owner.transfer(request) -> TenantMemberResponse

🔌 Usage

client.tenants().owner().transfer(
    TransferTenantOwnerRequest
        .builder()
        .memberId("member_id")
        .build()
);

⚙️ Parameters

memberId: String

Tenants Self

client.tenants.self.getUsageReports() -> TenantUsageReport

🔌 Usage

client.tenants().self().getUsageReports();
client.tenants.self.get() -> Tenant

🔌 Usage

client.tenants().self().get();
client.tenants.self.update(request) -> Tenant

🔌 Usage

client.tenants().self().update(
    UpdateTenantRequest
        .builder()
        .name("name")
        .build()
);

⚙️ Parameters

name: String

settings: Optional<Map<String, Optional<String>>>

client.tenants.self.delete()

🔌 Usage

client.tenants().self().delete();

Threeds Sessions

client.threeds.sessions.create(request) -> CreateThreeDsSessionResponse

🔌 Usage

client.threeds().sessions().create(
    CreateThreeDsSessionRequest
        .builder()
        .build()
);

⚙️ Parameters

pan: Optional<String>

tokenId: Optional<String>

tokenIntentId: Optional<String>

type: Optional<String>

device: Optional<String>

webChallengeMode: Optional<String>

deviceInfo: Optional<ThreeDsDeviceInfo>

authenticationRequest: Optional<AuthenticateThreeDsSessionRequest>

callbackUrls: Optional<ThreeDsCallbackUrls>

metadata: Optional<Map<String, Optional<String>>>

client.threeds.sessions.authenticate(sessionId, request) -> ThreeDsAuthentication

🔌 Usage

client.threeds().sessions().authenticate(
    "sessionId",
    AuthenticateThreeDsSessionRequest
        .builder()
        .authenticationCategory("authentication_category")
        .authenticationType("authentication_type")
        .build()
);

⚙️ Parameters

sessionId: String

request: AuthenticateThreeDsSessionRequest

client.threeds.sessions.getChallengeResult(sessionId) -> ThreeDsAuthentication

🔌 Usage

client.threeds().sessions().getChallengeResult("sessionId");

⚙️ Parameters

sessionId: String

client.threeds.sessions.get(id) -> ThreeDsSession

🔌 Usage

client.threeds().sessions().get("id");

⚙️ Parameters

id: String

Webhooks Events

client.webhooks.events.list() -> List&lt;String&gt;

📝 Description

Return a list of available event types

🔌 Usage

client.webhooks().events().list();