Skip to main content
API docs by Redocly

Purse - Vault API (v1)

Download OpenAPI specification:Download

License: Purse

Vault API

Forms

Vault API Forms

Submit a payment form

Submit a payment form to the vault API.

Authorizations:
purse_oauth2
path Parameters
tenant
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Tenant identifier

Request Body schema: application/json
required
object (PaymentCardFormCardApplication)

Payment card form submitted by the user.

cvv
string (PaymentCardFormCvvApplication) ^[0-9]{3,4}$

Card Verification Value (CVV) of the payment card

Responses

Request samples

Content type
application/json
Example
{
  • "card": {
    },
  • "cvv": "123"
}

Response samples

Content type
application/json
{
  • "form_token": "32oufdHG56-O87sbsaWdRtZ7Q1_ziLAx",
  • "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
  • "created_at": "2025-10-01T20:00:00Z",
  • "expires_at": "2025-10-01T20:12:00Z",
  • "card": {
    },
  • "cvv_token": "uEq9stsNhuIJ9UDT0wY0tqy8nDmrNRRI",
  • "card_holder_name": "John Doe",
  • "save_token": true,
  • "selected_network": "CARTE_BANCAIRE"
}

Get form by token

Retrieve tokens for pan and cvv.

Authorizations:
purse_oauth2
path Parameters
tenant
required
string <uuid>
Example: 123e4567-e89b-12d3-a456-426614174000

Tenant identifier

form_token
required
string^[a-zA-Z0-9_-]{32}$
Example: 32oufdHG56-O87sbsaWdRtZ7Q1_ziLAx

Form token to identify the submitted form

Responses

Response samples

Content type
application/json
{
  • "form_token": "32oufdHG56-O87sbsaWdRtZ7Q1_ziLAx",
  • "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
  • "created_at": "2025-10-01T20:00:00Z",
  • "expires_at": "2025-10-01T20:12:00Z",
  • "card": {
    },
  • "cvv_token": "uEq9stsNhuIJ9UDT0wY0tqy8nDmrNRRI",
  • "card_holder_name": "John Doe",
  • "save_token": true,
  • "selected_network": "CARTE_BANCAIRE"
}