curl --request POST \
--url https://sandbox-platform.jupico.com/v1/tokenization/bankaccount/raw \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"subMerchantId": "jpt-sim-md-1",
"accountType": "checking",
"accountHolderName": "John Doe",
"accountNumber": "12312311",
"routingNumber": "122187238"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/tokenization/bankaccount/raw"
payload = {
"subMerchantId": "jpt-sim-md-1",
"accountType": "checking",
"accountHolderName": "John Doe",
"accountNumber": "12312311",
"routingNumber": "122187238"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subMerchantId: 'jpt-sim-md-1',
accountType: 'checking',
accountHolderName: 'John Doe',
accountNumber: '12312311',
routingNumber: '122187238'
})
};
fetch('https://sandbox-platform.jupico.com/v1/tokenization/bankaccount/raw', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/tokenization/bankaccount/raw';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subMerchantId: 'jpt-sim-md-1',
accountType: 'checking',
accountHolderName: 'John Doe',
accountNumber: '12312311',
routingNumber: '122187238'
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "0",
"message": "Tokenization success",
"data": {
"paymentToken": {
"type": "echeck",
"token": {
"provider": "jupico",
"token": "8b728fb4-976c-43c1-8402-04c23ac18861",
"accountType": "checking",
"routingLast4Digits": "7238",
"accountLast4Digits": "2311",
"accountHolderName": "John Doe"
}
}
}
}Tokenize raw bank account data
Exchanges a customer’s bank account details for a permanent Jupico token. Use the token in place of the account and routing numbers on eCheck sales. Tokenizing the same account number, routing number, and account type again returns the existing token. Requires bank account tokenization to be enabled for the product and the submerchant. Replaces the deprecated POST /v1/transactions/echeck/tokenize. See the bank account tokenization guide.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/tokenization/bankaccount/raw \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"subMerchantId": "jpt-sim-md-1",
"accountType": "checking",
"accountHolderName": "John Doe",
"accountNumber": "12312311",
"routingNumber": "122187238"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/tokenization/bankaccount/raw"
payload = {
"subMerchantId": "jpt-sim-md-1",
"accountType": "checking",
"accountHolderName": "John Doe",
"accountNumber": "12312311",
"routingNumber": "122187238"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subMerchantId: 'jpt-sim-md-1',
accountType: 'checking',
accountHolderName: 'John Doe',
accountNumber: '12312311',
routingNumber: '122187238'
})
};
fetch('https://sandbox-platform.jupico.com/v1/tokenization/bankaccount/raw', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/tokenization/bankaccount/raw';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subMerchantId: 'jpt-sim-md-1',
accountType: 'checking',
accountHolderName: 'John Doe',
accountNumber: '12312311',
routingNumber: '122187238'
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "0",
"message": "Tokenization success",
"data": {
"paymentToken": {
"type": "echeck",
"token": {
"provider": "jupico",
"token": "8b728fb4-976c-43c1-8402-04c23ac18861",
"accountType": "checking",
"routingLast4Digits": "7238",
"accountLast4Digits": "2311",
"accountHolderName": "John Doe"
}
}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
Raw bank account details to tokenize. The endpoint rejects any field not listed here.
Submerchant that owns the bank account. Must be active, belong to your product, and have bank account tokenization enabled.
100^[a-zA-Z0-9\-_'.,@&:#%() ]+$"jpt-sim-md-1"
Bank account type.
checking, savings "checking"
Name on the bank account, up to 100 characters. The holder can be a person or a business. Allowed characters: letters, digits, spaces, and - _ ' . , @ & : # % ( ). Accents and look-alike characters are normalized before validation (for example, José becomes Jose).
100^[a-zA-Z0-9\-_'.,@&:#%() ]+$"John Doe"
Bank account number, 4 to 17 digits only.
4 - 17^[0-9]+$"12312311"
9-digit ABA routing number. Must pass the ABA checksum.
^[0-9]{9}$"122187238"
Response
Bank account tokenized.
Whether the request was processed successfully.
true
Machine-readable result code. See the Error Codes reference.
"0"
Human-readable result message.
"Tokenization success"
The response payload.
Hide child attributes
Hide child attributes
Permanent payment token to use in place of the raw bank account details.
Hide child attributes
Hide child attributes
Payment method type. Always echeck for bank accounts.
"echeck"
The bank account token and its non-sensitive details.
Hide child attributes
Hide child attributes
Token provider. Always jupico.
"jupico"
Permanent bank account token. Send it in paymentToken.token.token on eCheck sales.
"8b728fb4-976c-43c1-8402-04c23ac18861"
Bank account type: checking or savings.
"checking"
Last 4 digits of the routing number.
"7238"
Last 4 digits of the bank account number.
"2311"
Name on the bank account, as stored when the token was first created.
"John Doe"
Friendly name stored with the token. Present only if the token was created with an alias through the deprecated endpoint.
Was this page helpful?