Accounts and Cards

Create Provisioning Request

Changed on

Use the Create Provisioning Request endpoint to push-provision a virtual card to a mobile wallet. This endpoint is part of a multiple-step integration that must be completed with each mobile wallet partner. Consult the <a href="doc:creating-a-provisioning-request" target="_blank">Creating a Provisioning Request</a> guide for instructions on using this endpoint.

post/createProvisioningRequest

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/createProvisioningRequest
  • Auth
    none declared

Request body application/x-www-form-urlencoded

accountNostring required

The <glossary:PRN>, <glossary:PAN> or <glossary:CAD> of the account. For card-specific endpoints such as this one, the CAD is preferred. Do not use the PRN if more than one card has ever been associated with this account. Pattern: PAN, PRN, or CAD Example: "074103447228"

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

cert1string hexadecimal digits nullable

The leaf certificate returned by the wallet provider that was signed using cert2. Should be the hexlified (case insensitive) binary data of the certificate. See <a href="doc:creating-a-provisioning-request#certificate-formatting" target="_blank">Certificate formatting</a> for more information. Required for Apple Pay; not required for Samsung Pay or Google Pay.

cert2string hexadecimal digits nullable

The subordinate certificate returned by the wallet provider that was signed using the wallet provider’s Certificate Authority (CA) certificate. Should be the hexlified (case insensitive) binary data of the certificate. See <a href="doc:creating-a-provisioning-request#certificate-formatting" target="_blank">Certificate formatting</a> for more information. Required for Apple Pay; not required for Samsung Pay or Google Pay.

clientDeviceIDstring nullable

Value returned by Google Pay or Samsung Pay for use with Visa. Required for Visa + Samsung Pay or Google Pay; not required for Visa + Apple Pay.

clientWalletAccountIDstring nullable

Value returned by Google Pay or Samsung Pay for use with Visa. Required for Visa + Samsung Pay or Google Pay; not required for Visa + Apple Pay.

noncestring hexadecimal digits nullable

The hexlified (case insensitive) nonce value returned by Apple Pay. Required for Apple Pay; not required for Google Pay or Samsung Pay. Pattern: 8 character nonce value Example: "9c023092"

nonceSignaturestring hexadecimal digits nullable

The hexlified (case insensitive) nonce signature value returned by Apple Pay. Required for Apple Pay (not required for web push provisioning); not required for Google Pay or Samsung Pay. Pattern: Nonce signature value Example: "4082f883ae62..."

provisioningSource'in_app' | 'web' nullable

The source of the provisioning request. Accepted values: "in_app", "web". Defaults to "in_app" in the provisioner when not provided. Example: "web"

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

walletProvider1 | 2 | 3 | 4 | 5 required

The type of wallet to provision:

  • 1 — Apple Pay
  • 2 — Google Pay
  • 3 — Samsung Pay
  • 4 — Apple Pay Web Pattern: One digit Example: 2

Example request

{
  "accountNo": "074103447228",
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "nonce": "9c023092",
  "nonceSignature": "4082f883ae62...",
  "provisioningSource": "in_app",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "walletProvider": 2
}

Response

Successful response

errorsstring[]

A list of errors generated while the request was processed

processing_timenumber nullable required

The time elapsed in processing the transaction

rtokenstring nullable required

A system-generated ID used for tracking

statusstring nullable required

The condition of a process or response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

system_timestampstring date-time nullable required

A system generated timestamp

Changes

    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 18

    • warning

      the request property's maxLength was set to 60

    • info

      added the new 5.00 enum value to the request property

    • info

      the request property format was generalized from int32 to no format

    • info

      added the success response with the status