Use the SubClientID in supported API request URLs to associate with a specific SubClient.

Append the SubClientID to your ClientID with an underscore (_):

...{ClientID}_{SubClientID} ...

SubClient-Level Requests

Use the combined ClientID and SubClientID for transaction processing and supported payment verification requests.

Key APIs

For example, to create a transaction for a SubClient:

https://{FQDN}:{PORT}/v1/clients/{ClientID}_{SubClientID}/transactions

The transaction is associated with the SubClient identified in the request URL.

Create Transaction

See the Create Transaction API example below using a SubClientID in the URL endpoint.

Request

https://{FQDN}/v1/clients/{ClientID}_{SubClientID}/transactions?authorize

{
    "accounts": {
        "sourceAccount": {
            "card": {
                "accountNumber": "4111111111111111",
                "expirationDate": "202708",
                "securityCode": "232"
            },
            "owner": {
                "name": {
                    "first": "Test",
                    "last": "Name"
                }
            }
        },
        "destinationAccountID": "{{settlementAccountID}}"
    },
    "referenceID": "1kdev091425",
    "type": "pull",
    "amount": "2.00"
}

Response

{
    "SC": 200,
    "EC": "0",
    "transactionID": "AOIcfNSEUW-oGWoVIVSyqA",
    "network": "Visa",
    "networkRC": "00",
    "networkID": "2025091722162799832",
    "status": "AUTHORIZED",
    "approvalCode": "221627",
    "AVS": {
        "codeSecurityCode": "M"
    },
    "additional": {
        "par": "V41111111114589CED5703F989F79"
    },
    "card": {
        "last4": "1111",
        "expirationDate": "202708",
        "nameFI": "FORD Instiution"
    }
}

Client-Level Requests

Some resources remain at the Client level and should not include the SubClientID.

For example, use the Create Account API to create PCI compliant accounts with:

https://{FQDN}:{PORT}/v1/clients/{ClientID}/accounts

Do not append the SubClientID to Account API request URLs.

Verification APIs

Use your Client-level URL when completing the standard Verification Flow. The Verification Flow creates and verifies the User before the SubClient v2 is created, so a SubClientID is not typically included.

Note: in very select use cases, a SubClient may be used of the Verification APIs.

Find Your SubClientID

TabaPay returns a SubClientID when a SubClient is created. SubClients created through either SubClient v2 or SubClient v4 can use their SubClientID with supported SubClient-level requests.

To understand differences between v2 or v4 refer to SubClients.

For SubClient creation, refer to:

• SubClient v2
• SubClient v4

Recipes