Provision payment service token
Tokenize stored card against a payment service.
This endpoint requires the payment-methods.write
scope.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The ID of the payment method.
Body
Request body for provision a payment service token.
The ID of the payment service.
The redirect URL to redirect a buyer to after they have authorized their payment method. This only applies to payment methods that require buyer approval.
The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD.
The security code can only be set if the stored payment method represents a card.
3 - 4
Response
A payment service token.
The type of this resource.
payment-service-token
The unique ID of the token.
The unique ID of the payment method.
The unique ID of the payment service.
The state of the token.
processing
- The payment method is still being stored.buyer_approval_required
- Storing the payment method requires the buyer to provide approval. Follow theapproval_url
for next steps.succeeded
- The payment method is approved and stored with all relevant payment services.failed
- Storing the payment method did not succeed.
processing
, buyer_approval_required
, succeeded
, failed
The optional URL that the buyer needs to be redirected to to further authorize their payment.
The token value. Will be present if succeeded.
The date and time when this token was first created in our system.
The date and time when this token was last updated in our system.
Was this page helpful?