The request is used to get a token for the recipient's bank card along with the 3-D Secure verification details to later use them in a payout transaction.
As a result of a tokenization transaction, money isn't transferred to the recipient's card. Use the received token to send a payout request.
Request
To get the recipient's card tokenized, send a POST request to https://processing.ecomcharge.com/transactions/recipient_tokenizations with the following parameters:
Note
The request body must be wrapped in a top-level request{} object.
description
string (255) The short description of the transaction.
tracking_id
string Your internal ID of the recipient's card tokenization transaction. If the tracking_id is not unique per transaction, the system returns an array of up to 10 recent transactions with a matching tracking ID in the response to the query request. Can be multiple values separated with semicolons. For example, "cbe59142-90af-4aea-b5a5-5bf3f66cf3da;f7883cb9-0e26-43a7-beb7-4027cb55d1a6;4a6a89d5-6950-400f". If multiple values are sent in the request, the transaction search in the back office system can be performed by any of them.
object A section of the recipient's billing address.
Ask the Tech Support Team if your acquirer requires any of the section parameters.
first_name
conditionally required
string (30) The recipient's first name.
last_name
conditionally required
string (30) The recipient's last name.
country
conditionally required
string The recipient's billing country in ISO 3166-1 Alpha-2 format.
city
conditionally required
string (60) The recipient's billing city.
state
conditionally required
string The recipient's two-letter billing state only if the billing address country is IN, US or CA.
zip
conditionally required
string The recipient's billing ZIP or postal code. If country=US, zip format must be NNNNN or NNNNN-NNNN
address
conditionally required
string (255) The recipient's billing address.
phone
conditionally required
string (100) The recipient's phone number.
object A section of the recipient's card details.
number
required
string (19) Card number.
holder
conditionally required
string (35) The cardholder name as it appears on the card. The parameter is optional in the eComCharge system but can be required by the acquirer.
exp_month
conditionally required
string (2) Card expiration month. Must be one or two digits (for example, 01).
exp_year
conditionally required
string (4) Card expiration year. Must be 4 digits (for example, 2027).
object A section of the recipient information.
Ask the Tech Support Team whether your acquirer requires any of the section parameters.
ip
conditionally required
string The customer's IP address.
email
conditionally required
string The customer's email.
device_id
conditionally required
string The customer's device ID (desktop, smartphone, etc.).
birth_date
conditionally required
string The customer's birth date in ISO 8601 format YYYY-MM-DD.
external_id
string (255) The customer's identifier in the merchant's system.
string A payment method used to complete the transaction.
Possible values: credit_card.
tracking_id
required
string The tracking_id parameter value sent in the transaction request.
message
required
string A processing result message.
created_at
required
string The transaction creation date.
updated_at
required
string The transaction update date. For example, a status update.
object
holder
string The recipient's name.
stamp
required
string The card hash. It is constant even if the expiration date or the card holder are changed.
token
required
string The card token. Store the token and charge the returning customers or run recurring charges without the customers' billing details. The token lets you save the customer's details and charge them whenever they make new purchases, or you renew their services.
string (6) 6-digit bank identification number (BIN). The first 6 digits of the card number.
bin_8
required
string (8) 8-digit bank identification number (BIN). The first 8 digits of the card number. The value is returned for Visa, MasterCard, Maestro cards and the corresponding co-branded cards. Otherwise, null is returned.
issuer_country
required
string (2) The country of the card issuing bank in ISO 3166-1 Alpha-2 format.