Create Single-Use Virtual Card

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/createSingleUseVirtualCard

Use the Create Single-Use Virtual Card endpoint to create a single-use virtual card for a BNPL customer. To use this endpoint with a product, the SUVC product parameter must be set to Y, indicating that the product is a single-use virtual card.

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
605-01	The product that corresponds with the `prodId` does not support single-use virtual cards. Occurs when SUVC is not set to `Y`.
605-02	Error creating the new account for the SUVC card
605-03	setCreditLimit error

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

integer

required

Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

primaryAccountNo

string

required

^$|^([0-9]{12}|[0-9]{16})$

The PRN or PAN of an existing account held by the customer receiving the single use virtual card
Pattern: PAN or PRN
Example: "074103447228"

prodId

integer

required

0 to 100000000

A unique product identifier from SoFi Tech Solutions.
Pattern: Max 9 digits
Example: 501

creditLimit

number

required

≥ 0

Credit limit for the single-use virtual card. Minimum value is 50.00.
Pattern: Decimal number (14, 2)
Example: 500.25

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default