Get a Payment Token
POST /v2/b2b/paymentToken
Body
A Payment Token object with the following fields populated
- saleChannel
- paymentData.manualEntryCardNumber
- paymentData.expDate
Sample Request
{ "saleChannel":"Online", "paymentData": { "manualEntryCardNumber":"4242424242424242", "expDate":"1220", "creditCardVerificationData": { "zipCode": "00000" } }} |
Response
A Payment Token object with the following fields populated
- uuid
- saleChannel
- paymentProcessor
- usage
AVS is optional but will be enforced according to the B2C AVS configuration set in back office. If addresses are not required but provided, AVS will still run.
Sample Response
{ "uuid": "93994b65-4433-4696-835e-10bb798ec3eb", "paymentProcessor": "EXPRESS", "saleChannel": "POS", "usage": 0} |
Delete a PaymentToken
Delete /v2/b2b/paymentToken/{uuid}
parameters
- uuid of the payment token
Response
The Payment Token object that was deleted
Payment Token JSON Object
All fields read only except where otherwise stated
Field | Description | Notes |
|---|---|---|
| saleChannel | Online, Pos, Kiosk | Required for create |
| uuid | unique identifier to be passed in at B2C Checkout - DEPRECIATED in the "paymentProcessorToken" field | |
| paymentProcessor | (Vantiv/Stripe/Express) payment processor - should always be the same as the tenant's | |
| usage | the number of times this token has been used | should never exceed 1 for v1 |
| paymentData | payment data | Required for create Create only |
| paymentData.manualEntryCardNumber | card number | |
| paymentData.expDate | expirationDate (MMYY) | API only validates formatting. Express does not validate the value either, so if value validation is required, it should be done before calling the API |
| paymentData.cvc | card verification code | Optional |
| paymentData.creditCardVerificationData | for AVS checks | Optional for create Create only |
| paymentData.creditCardVerificationData.address1 | address1 for AVS check | |
| paymentData.creditCardVerificationData.address2 | address2 for AVS check | |
| paymentData.creditCardVerificationData.country | country for AVS check | |
| paymentData.creditCardVerificationData.city | city for AVS check | |
| paymentData.creditCardVerificationData.state | state for AVS check | |
| paymentData.creditCardVerificationData.zipCode | zipCode for AV check | AVS check will run as long as there is a valid zip code |