Creating a token

post

https://api.processout.com/customers/{customer_id}/tokens

Path Params

customer_id

string

required

ID of your customer

Body Params

invoice_id

string

Invoice ID that'll be used to verify the token. By default, ProcessOut will create its own invoice.

description

string

Description that will be sent to the tokenization gateway service.

invoice_return_url

string

This is the URL to be set on the invoice that is created for card verification (when verify is set to true).
Must be a valid URL

return_url

string

For APMs, this is the URL to return to the app after payment is accepted.
Must be a valid URL

cancel_url

string

For APMs, this is the URL to return to the app after payment is canceled.
Must be a valid URL

source

string

If you already have the payment details (card_ or gway_req_), you can already assign it to the token.

verify

boolean

Flag if you wish to verify the customer token by making zero value transaction. Applicable for cards only.

verify_statement_descriptor

string

Statement descriptor set for invoice in verification flow. Used only when verify is true.

verify_metadata

string

Metadata set for invoice in verification flow. Used only when verify is true and no custom invoice ID passed in.

manual_invoice_cancellation

boolean

If set to true, verification invoice will not automatically be voided after verification. This parameter controls autovoid when a custom invoice is created for token verification.

This is to perform verification on PSPs that do not support explicit verification, or you are wanting to conduct a buy and tokenize flow whereby this must be set to true (Please reach out to your account manager to understand PSP Support for this.)

webhook_url

string

Custom webhook URL for this customer token. Customer token events will be sent to this URL on top off your webhook endpoint URL.
Must be a valid URL

device

object

Information about the device and channel used by the customer to initiate the payment.

preferred_scheme

string

The scheme the customer would prefer to process the transaction on. Ex: carte bancaire vs visa. This only applies to card verifications.

Headers

Idempotency-Key

string

Unique key to your request that will be used for idempotency

Responses

Language

Credentials

Basic

base64

Loading…

Response

Choose an example:

application/json

200200

400400

401401

404404

4XX4XX