1. Home
  2. Docs
  3. V1
  4. Backend API
  5. API Reference

API Reference

The API Base Url is: 

https://api.paymentworkflowtech.com/v1

Nonce

Route: /nonce [POST]

Body: {
clientKey,
remoteID,
logData
}

Returns:{
nonce : string,
errorCode : int – 0 Means no error,
errorMessage : string
}

Description : Used to procure an Nonce for use with other interactions with the system.

Stripe

Route : /stripe/updateid [POST]

Body:{
clientKey,
remoteID,
stripeID,
logData
}

Returns:{
errorCode : int – 0 Means no error,
errorMessage : string
}

Description: Used to set the Stripe Account ID of the user’s Connected Account.

Route : /stripe/updatekey [POST]

Body:{
clientKey,
stripeKey,
logData
}

Returns:{
errorCode : int – 0 Means no error,
errorMessage : string
}

Description: Used to set your Stripe API Key so that Secure Store can update the bank accounts in the user Connected Accounts.

Route : /stripe/batch [POST]

Body:{
clientKey,
mapping :[{remoteID,stripeID}],
logData
}

Returns:{
errorCode : int – 0 Means no error,
errorMessage : string
}

Description: Used to set the Stripe Account ID for multiple users. The mapping is an array of {remoteID, stripeID}.

Response

Route /response [POST]

Body: {
nonce,
accountNumber,
routingNumber,
fullName,
accountType (“individual” or “business”)
}

Returns:{
errorCode : int – 0 Means no error,
errorMessage : string
}

Description: Used to post user data. The IFrame method should be the primary way of submitting this data. This route is here in case a backup method is needed.

Responses

Route: /responses [POST]

Body:{
clientKey
}

Returns:{
“users”: [
    {     
remoteID : string
        stripeID : string – Empty if not set
        accountSet : bool
        routingSet : bool
    }
]
}

Description: Used to retrieve a list of users with checks for whether Account number, Routing Number and Stripe ID are set.

IFrame Header

Route: /iframeheader [POST]

Body:{
clientKey,
header,
logData
}

Returns:{
errorCode : int – 0 Means no error,
errorMessage : string
}

Description: Sets the Text/Html to display at the top of the Iframe presented to the user.

Was this article helpful to you? Yes No

How can we help?