Skip to content
API reference
/
Payments
/
/
List personal payment sou...

Payments API (v2)

Download OpenAPI description
PaymentsApi.json
PaymentsApi.yaml
Languages
Servers
Sandbox URL

https://api-ext-sboxmeta.partners.spotnana.com/

Spotnana mock server

https://developer.spotnana.com/_mock/openapi/paymentsapi/

Payments

APIs related to Cards, Payments and Fees.

Service Charge

Operations

Personal Payment Sources

Operations

List personal payment sources for a User

Request

Security
Bearer
Path
userIdstring(uuid)required

Identifier for User Profile

Example: 4974a66b-7493-4f41-908c-58ba81093947
Query
offsetinteger>= 0

Indicates from where in the list of Payment Sources the server should start.

Default 0
limitinteger[ 0 .. 10 ]

Maximum number of results to be fetched for the query.

Default 10
curl -i -X GET \
  'https://api-ext-sboxmeta.partners.spotnana.com/v2/payment/users/4974a66b-7493-4f41-908c-58ba81093947/payment-sources?offset=0&limit=10' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
paymentSourceInfosArray of objects(PaymentSourceInfoV2)

List of payment sources

paginationParamsobject(OffsetBasedPaginationResponseParams)
Response
application/json
{
  "paymentSourceInfos": [
    { … }
  ],
  "paginationParams": {
    "totalNumResults": 0
  }
}

Create Personal Payment Source.

Request

Security
Bearer
Path
userIdstring(uuid)required

Identifier for User Profile

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/json
paymentSourceInfoobject(PaymentSourceInfoV2)required
paymentSourceInfo.​paymentSourcePaymentSourceDetails (object)(PaymentSourceDetails)required
PaymentSourceDetails (object)(PaymentSourceDetails)
paymentSourceInfo.​filterUsagePaymentFilter (object)(UsagePaymentFilter)required
One of:

Applicable Filters i.e. access level, travel type information etc.

paymentSourceInfo.​filter.​typestringrequired
Example: "PERSONAL"
paymentSourceInfo.​filter.​travelTypesArray of strings(TravelType)[ 1 .. 6 ] itemsrequired

Applicable payment source travel types

Items Enum"AIR""HOTEL""CAR""RAIL""LIMO""MISC""ALL"
Example: ["AIR"]
paymentSourceInfo.​filter.​managedTravelerAccessobject(ManagedTravelerPaymentAccess)
paymentSourceInfo.​externalIdstring

An identifier assigned by a partner system. Once attached to a payment source, it remains unique per user and cannot be reassigned to another payment source.

Example: "bxt_RNGsNfzgJDaTstKIKqK4xEuhGYAnMdYK8T40"
curl -i -X POST \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/payment/users/4974a66b-7493-4f41-908c-58ba81093947/payment-sources \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentSourceInfo": {
      "paymentSource": {
        "type": "CARD",
        "card": {
          "company": "VISA",
          "name": "Harrison Schwartz",
          "address": {
            "addressLines": [
              "Golden Gate Bridge"
            ],
            "administrativeArea": "CA",
            "administrativeAreaName": "California",
            "description": "San Francisco Home",
            "isDefault": true,
            "languageCode": "en",
            "locality": "San Francisco",
            "locationCode": "LAX",
            "organization": "Spotnana",
            "postalCode": "94130",
            "continentCode": "AF",
            "recipients": [
              "string"
            ],
            "regionCode": "US",
            "regionName": "America",
            "revision": 1,
            "sortingCode": "Jamaica",
            "sublocality": "string",
            "timezone": "America/Los_Angeles",
            "coordinates": {
              "latitude": 77.1025,
              "longitude": 28.7041
            }
          },
          "number": "4111111111111111",
          "cvv": "012",
          "label": "Label amex",
          "expiry": {
            "expiryMonth": 1,
            "expiryYear": 2010
          },
          "ownershipLabel": "CORPORATE"
        }
      },
      "filter": {
        "type": "PERSONAL",
        "travelTypes": [
          "AIR"
        ],
        "managedTravelerAccess": {
          "enabled": false,
          "visibility": {
            "showToTravelers": false
          }
        }
      },
      "externalId": "bxt_RNGsNfzgJDaTstKIKqK4xEuhGYAnMdYK8T40"
    }
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

Unique identifier identifying the created payment source, if created.

Example: "f49d00fe-1eda-4304-ba79-a980f565281d"
statusstring(PaymentSourceStatus)read-only
Enum"ACTIVE""INCOMPLETE""TEMPORARY_READY""TEMPORARY_USED""TEMPORARY_EXPIRED""TEMPORARY_INCOMPLETE"
authenticationInfoobject(AuthenticationInfo)
Response
application/json
{
  "id": "f49d00fe-1eda-4304-ba79-a980f565281d",
  "status": "ACTIVE",
  "authenticationInfo": {
    "authUrl": "string"
  }
}

Fetch a personal payment source

Request

Security
Bearer
Path
userIdstring(uuid)required

Identifier for User Profile

Example: 4974a66b-7493-4f41-908c-58ba81093947
paymentSourceIdstring(uuid)required

Identifier for personal paymentSource.

Example: 4974a66b-7493-4f41-908c-58ba81093947
curl -i -X GET \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/payment/users/4974a66b-7493-4f41-908c-58ba81093947/payment-sources/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
paymentSourceobject(PaymentSourceInfoV2)
Response
application/json
{
  "paymentSource": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "paymentSource": { … },
    "filter": { … },
    "status": "ACTIVE",
    "externalId": "bxt_RNGsNfzgJDaTstKIKqK4xEuhGYAnMdYK8T40"
  }
}

Delete a Personal Payment Source.

Request

Security
Bearer
Path
userIdstring(uuid)required

Identifier for User Profile

Example: 4974a66b-7493-4f41-908c-58ba81093947
paymentSourceIdstring(uuid)required

Identifier for personal paymentSource.

Example: 4974a66b-7493-4f41-908c-58ba81093947
curl -i -X DELETE \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/payment/users/4974a66b-7493-4f41-908c-58ba81093947/payment-sources/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Response
No content

Update a Personal Payment Source.

Request

Security
Bearer
Path
userIdstring(uuid)required

Identifier for User Profile

Example: 4974a66b-7493-4f41-908c-58ba81093947
paymentSourceIdstring(uuid)required

Identifier for personal paymentSource.

Example: 4974a66b-7493-4f41-908c-58ba81093947
Bodyapplication/json
paymentSourceInfoPaymentSourceUpdateDetails (object)(PaymentSourceUpdateDetails)required
PaymentSourceUpdateDetails (object)(PaymentSourceUpdateDetails)
filterUsagePaymentFilter (object)(UsagePaymentFilter)
One of:

Applicable Filters i.e. access level, travel type information etc.

curl -i -X PATCH \
  https://api-ext-sboxmeta.partners.spotnana.com/v2/payment/users/4974a66b-7493-4f41-908c-58ba81093947/payment-sources/4974a66b-7493-4f41-908c-58ba81093947 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "paymentSourceInfo": {
      "paymentType": "CARD",
      "card": {
        "address": {
          "addressLines": [
            "Golden Gate Bridge"
          ],
          "administrativeArea": "CA",
          "administrativeAreaName": "California",
          "description": "San Francisco Home",
          "isDefault": true,
          "languageCode": "en",
          "locality": "San Francisco",
          "locationCode": "LAX",
          "organization": "Spotnana",
          "postalCode": "94130",
          "continentCode": "AF",
          "recipients": [
            "string"
          ],
          "regionCode": "US",
          "regionName": "America",
          "revision": 1,
          "sortingCode": "Jamaica",
          "sublocality": "string",
          "timezone": "America/Los_Angeles",
          "coordinates": {
            "latitude": 77.1025,
            "longitude": 28.7041
          }
        },
        "label": "Label amex",
        "ownershipLabel": "CORPORATE"
      }
    },
    "filter": {
      "type": "PERSONAL",
      "travelTypes": [
        "AIR"
      ],
      "managedTravelerAccess": {
        "enabled": false,
        "visibility": {
          "showToTravelers": false
        }
      }
    }
  }'

Responses

OK

Response
No content
Copyright © 2025 Spotnana Technology, Inc.