API Endpoints
post
Authorizations
Body
firstNamestringRequiredExample:
Brandon
lastNamestringRequiredExample:
Lewis
dobstringRequiredExample:
1993-09-19
ssnstringRequiredExample:
221-02-9758
addressall ofRequired
Responses
201
Successful Operation
application/json
400
Error processing the information
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
404
Error processing The information
application/json
422
Error processing the information
application/json
500
Error processing the information
application/json
post
POST /baas/customer-enrollment HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 265
{
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"ssn": "221-02-9758",
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
}
}
{
"statusCode": 201,
"data": {
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
},
"status": "active",
"kycStatus": "approved",
"userExternalId": "c08b9baf-4791-42e1-8d10-94bbbcdee1f9"
}
}
post
Authorizations
Responses
201
Successful Operation
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
500
Error processing the information
application/json
post
POST /baas/customer-complete-enrollment HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 201,
"data": {
"status": "active"
}
}
get
Authorizations
Responses
200
Successful Operation
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
500
Error processing the information
application/json
get
GET /baas/customers HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
},
"status": "active",
"kycStatus": "approved",
"userExternalId": "c08b9baf-4791-42e1-8d10-94bbbcdee1f9"
}
}
put
Authorizations
Body
firstNamestringRequiredExample:
Brandon
lastNamestringRequiredExample:
Lewis
dobstringRequiredExample:
1993-09-19
ssnstringRequiredExample:
221-02-9758
addressall ofRequired
Responses
200
Successful Operation
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
Customer has not been created
application/json
500
Error processing the information
application/json
put
PUT /baas/customers HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 265
{
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"ssn": "221-02-9758",
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
}
}
{
"statusCode": 200,
"data": {
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
},
"status": "active",
"kycStatus": "approved",
"userExternalId": "c08b9baf-4791-42e1-8d10-94bbbcdee1f9"
}
}
get
Authorizations
Responses
200
Successful Operation
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
500
Error processing the information
application/json
get
GET /baas/compliance-workflows/latest HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"id": "myId",
"acceptedDocuments": [
{
"id": "myDocumentId",
"name": "Terms and Conditions",
"complianceDocumentUrl": "myDocumentUrl",
"electronicSignatureRequired": "Brandon Lewis"
}
],
"currentStepDocumentsPending": [
{
"id": "myDocumentId",
"name": "Terms and Conditions",
"complianceDocumentUrl": "myDocumentUrl",
"electronicSignatureRequired": "Brandon Lewis"
}
],
"allDocuments": [
{
"id": "myDocumentId",
"name": "Terms and Conditions",
"complianceDocumentUrl": "myDocumentUrl",
"electronicSignatureRequired": "Brandon Lewis"
}
]
}
}
get
Authorizations
Responses
200
Successful Operation
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
Customer has not been created
application/json
500
Error processing the information
application/json
get
GET /baas/customer-accounts HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"accounts": [
{
"id": "myAccountId",
"status": "active",
"availableBalance": "100",
"balance": "100",
"pendingBalance": "15",
"accountNumber": "83534957",
"routingNumber": "977962271",
"category": "primary",
"type": "savings",
"currencyCode": "USD",
"name": "Bank Of America"
}
]
}
}
get
Authorizations
Path parameters
accountIdstringRequired
Responses
200
Successful Operation
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
Customer has not been created
application/json
500
Error processing the information
application/json
get
GET /baas/customer-accounts/{accountId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"id": "myAccountId",
"status": "active",
"availableBalance": "100",
"balance": "100",
"pendingBalance": "15",
"accountNumber": "83534957",
"routingNumber": "977962271",
"category": "primary",
"type": "savings",
"currencyCode": "USD",
"name": "Bank Of America"
}
}
get
Authorizations
Responses
200
Successful Operation
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
Customer has not been created
application/json
500
Error processing the information
application/json
get
GET /baas/debit-cards HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"cards": [
{
"id": "myCardId",
"accountId": "074103447228",
"cardLastFourDigits": "2043",
"status": "active",
"image": "myImageCardUrl",
"type": "virtual",
"isReadyToUse": true,
"isLocked": true
}
]
}
}
post
Authorizations
Body
idstringOptionalExample:
myCardId
accountIdstringOptionalExample:
074103447228
addressall ofOptional
Responses
201
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":201}
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
Customer has not been created
application/json
500
Error processing the information
application/json
post
POST /baas/debit-cards/physical HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 178
{
"id": "myCardId",
"accountId": "074103447228",
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
}
}
{
"statusCode": 201
}
post
Authorizations
Path parameters
cardIdstringRequired
Body
pinstringRequiredExample:
1234
Responses
201
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":201}
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
Customer has not been created
application/json
500
Error processing the information
application/json
post
POST /baas/debit-cards/{cardId}/set-pin HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"pin": "1234"
}
{
"statusCode": 201
}
get
Authorizations
Path parameters
cardIdstringRequired
Responses
200
Successful Operation
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
Customer has not been created
application/json
500
Error processing the information
application/json
get
GET /baas/debit-cards/{cardId}/info HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"name": "My Debit Card",
"cardNumber": "4716413853339473",
"expDate": "2027-01-01",
"verificationCode": "232",
"status": "active"
}
}
put
Authorizations
Path parameters
cardIdstringRequired
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200}
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
Customer has not been created
application/json
500
Error processing the information
application/json
put
PUT /baas/debit-cards/{cardId}/lock HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
get
Authorizations
Query parameters
pagenumberRequired
per_pagenumberRequired
Responses
200
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":200}
401
Failed because the authentication token is not sent or it has already expired.
application/json
500
Error processing the information
application/json
get
GET /baas/customer-ach-accounts?page=1&per_page=1 HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
post
Authorizations
Body
fromAccountIdstringRequiredExample:
999900857817
amountstringRequiredExample:
24.99
toAccountIdstringOptionalExample:
myAccountId
toAccountNumberstringOptionalExample:
86704702
toRoutingNumberstringOptionalExample:
746978438
toFirstNamestringOptionalExample:
Trinity
toLastNamestringOptionalExample:
Dickson
debitCreditIndicatorstring · enumOptionalExample:
credit
Possible values: toAccountTypestring · enumOptionalExample:
checking
Possible values: Responses
201
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":201}
401
Failed because the authentication token is not sent or it has already expired.
application/json
500
Error processing the information
application/json
post
POST /baas/transfer-ach HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 242
{
"fromAccountId": "999900857817",
"amount": "24.99",
"toAccountId": "myAccountId",
"toAccountNumber": "86704702",
"toRoutingNumber": "746978438",
"toFirstName": "Trinity",
"toLastName": "Dickson",
"debitCreditIndicator": "credit",
"toAccountType": "checking"
}
{
"statusCode": 201
}
get
Authorizations
Responses
200
Successful Operation.
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
500
Error processing the information
application/json
get
GET /baas/kyc-documents HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"id": "myKycDocumentId",
"kycStatus": "approved",
"kycDocuments": [
{
"category": 1,
"options": [
1
],
"outcome": "approved"
}
]
}
}
post
Authorizations
Body
idstringRequiredExample:
myId
documentstringRequiredExample:
myDocument
documentContentTypestringOptionalExample:
myDocumentContentType
fileNamestringOptionalExample:
myFileName
notestringOptionalExample:
myNote
categorystring · enumOptionalExample:
addressVerification
Possible values: optionstring · enumOptionalExample:
license
Possible values: metaall ofOptional
Responses
201
Successful Operation.
application/json
ResponseanyExample:
{"statusCode":201}
401
Failed because the authentication token is not sent or it has already expired.
application/json
500
Error processing the information
application/json
post
POST /baas/kyc-documents HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 220
{
"id": "myId",
"document": "myDocument",
"documentContentType": "myDocumentContentType",
"fileName": "myFileName",
"note": "myNote",
"category": "addressVerification",
"option": "license",
"meta": {
"countryCode": "1",
"stateCode": "510"
}
}
{
"statusCode": 201
}
get
Authorizations
Responses
200
Successful Operation
application/json
401
Failed because the authentication token is not sent or it has already expired.
application/json
403
Customer has not been created
application/json
500
Error processing the information
application/json
get
GET /baas/transactions HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"totalCount": 1,
"count": 1,
"limit": 1,
"offset": 1,
"transactions": [
{
"id": "myTransactionId",
"amount": "100",
"description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"createdAt": "2019-10-01 14:56:50",
"currencyCode": "USD",
"type": "myTransactionType",
"status": "myStatus",
"direction": "credit"
}
]
}
}
Last updated
Was this helpful?