Get all payment methods and include pre-authorized payment tokens when available
This request returns all payment methods with included pre-authorized tokens. The list will contain the pre-authorized amount (incl. currency), the purpose PRNs, all information about the payment method, and the paymentToken that can be used to complete the payment. If no payment method is associated with a pre-authorized token, the result will contain only the payment methods.
Query parameters
-
Value is
paymentTokens
. -
filter[purpose] string
When provided allows filtering by PACE resource name(s). Only payment methods suitable for the given purpose are returned.
Responses
-
200 application/vnd.api+json
All the payment methods with pre-authorized amounts and purpose PRNs.
-
401 application/vnd.api+json
OAuth token missing or invalid or a linked identity is missing.
Linked identity missing is a special case where you need to make sure that the user has additionally logged in / authorized with a third-party.
This is not relevant for most use-cases.
The specific error code that identifies a missing linked identity is
missing-linked-identity
Example:
{ "errors": [ { "id": "cbgmhslmp1o9or9kh1p0", "title": "Missing linked identity for authorized access", "detail": "Linked identity is needed to access this resource, please check why the user does not have a linked identity", "status": "401", "code": "missing-linked-identity" } ] }
-
406 application/vnd.api+json
The specified accept header is invalid
-
422 application/vnd.api+json
The request was well-formed but was unable to be followed due to semantic errors.
-
500 application/vnd.api+json
Internal server error
curl \
-X GET https://api.pace.cloud/pay/2024-3/payment-methods?include=paymentTokens&include=paymentTokens \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"data": [
{
"type": "paymentMethod",
"id": "d7101f72-a672-453c-9d36-d5809ef0ded6",
"attributes": {
"kind": "string",
"status": "verified",
"identificationString": "DEUTSCHEBANK XX 3000",
"vendorPRN": "prn:cms:payment-method-vendors:3af4b4a7-33fc-4930-9c2d-6eea7e488398",
"twoFactor": true,
"approvalURL": "string",
"alias": "My wifes card",
"implicit": false,
"pacePay": true,
"mandatoryAuthorisationAttributes": [
{
"name": "vin",
"regex": "[A-Z][0-9]+",
"maxLength": 8
},
{
"name": "driverVehicleID",
"regex": "[0-9a-zA-Z]+",
"maxLength": 10
},
{
"name": "mileage",
"regex": "[0-9]+",
"maxLength": 8
},
{
"name": "numberPlate",
"regex": "[A-Z][0-9]+",
"maxLength": 8
},
{
"name": "additionalData",
"regex": "[0-9]+",
"maxLength": 12
}
],
"expiry": "2006-01-02T15:04:05Z",
"managed": false,
"isEligibleForDiscounts": true
},
"meta": {
"merchantName": "PACE"
},
"relationships": {
"paymentMethodVendor": {
"data": {
"type": "paymentMethodVendor",
"id": "33331f72-a672-453c-9d36-d5809ef0ded6"
}
},
"paymentMethodKind": {
"data": {
"type": "paymentMethodKind",
"id": "33331f72-a672-453c-9d36-d5809ef0ded6"
}
},
"paymentTokens": {
"data": [
{
"type": "paymentToken",
"id": "33331f72-a672-453c-9d36-d5809ef0ded6"
}
]
}
},
"links": {
"authorize": {
"href": [
"/pay/payment-methods/6b071c65-ef8b-4794-8745-e53728b7617f/authorize",
"/pay/payment-method-kinds/applepay/authorize"
],
"meta": {
"authFlow": "token-provided"
}
}
}
}
],
"included": [
{
"type": "paymentToken",
"id": "33331f72-a672-453c-9d36-d5809ef0ded6",
"attributes": {
"amount": 23,
"currency": "EUR",
"value": "12c52345c1x34",
"validUntil": "2024-05-04T09:42:00+00:00",
"accountPRN": [
"prn:pay:accounts:pace"
],
"purposePRNs": [
"prn:poi:gas-stations:124e522d-65ef-4386-b7e0-00d2eceeadc6",
"prn:cms:fuels:ron95"
]
},
"relationships": {
"paymentMethod": {
"data": {
"type": "paymentMethod",
"id": "33331f72-a672-453c-9d36-d5809ef0ded6"
}
}
}
}
]
}
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}