Skip to main content
POST
/
api
/
v2
/
wallet
/
collect
{
  "id": "col_xyz789",
  "message": "Payment collected successfully",
  "request_id": "req_abc123",
  "status": "completed"
}

Authorizations

​
X-Auth0-Key
string
header
required

Internal use only

Headers

​
x-user-id
string
required

End-user identifier within a customer organization. Required for user-scoped operations.

Body

application/json

Request model for collecting new card information.

​
card_number
string
required

Card number

Required string length: 12 - 19
​
card_cvv
string
required

CVV code

​
card_holder
string
required

Card holder name

Required string length: 1 - 255
​
card_exp
string
required

Card expiration (MM/YY)

​
email
string<email>
required

Cardholder email

​
phone_number
string<phone>
required

Phone number in E.164 format

Examples:

"+12125551234"

"+442071234567"

"+972547828353"

​
billing_address
string
required

Billing address

Minimum length: 1
​
zip_code
string
required

ZIP code

​
last4_digits
string | null

Last 4 digits

​
city
string | null

City

Minimum length: 1
​
state
string | null

State/province code

​
is_default
boolean | null

Set as default payment method

Response

Confirmation of card collection with tokenized reference

V2 Payment Collection Response - success field removed (redundant with status).

​
status
string
required

Operation status

​
message
string
required

Status message

​
data
object | null

Additional data

​
request_id
string | null

Request tracking ID

​
id
string | null

Transaction/collection ID

⌘I