Get all ready-to-use payment methods for user, combining created and valid methods
This request will return a list of supported payment methods for the current user that they can, in theory, use. That is, ones that are valid and can immediately be used including methods that could be used if the verification step is complated.
This is as opposed to the regular /payment-methods
, which does not categorize payment methods as valid for use.
You should trigger this when the user is approaching on a gas station with fueling support to get a list of available payment methods.
If the list is empty, you can ask the user to add a payment method to use PACE fueling.
Query parameters
-
Value is
createdOrValid
. -
When provided allows filtering by PACE resource name(s). Only payment methods suitable for the given purpose are returned.
Responses
-
All the payment methods that could be used.
-
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" } ] }
-
Resource not found
-
The specified accept header is invalid
-
The request was well-formed but was unable to be followed due to semantic errors.
-
Internal server error
curl \
-X GET https://api.pace.cloud/pay/2024-1/payment-methods?filter[status]=createdOrValid&filter%5Bstatus%5D=createdOrValid \
-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": "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
},
"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": [
{
"id": "33331f72-a672-453c-9d36-d5809ef0ded6",
"type": "paymentMethodVendor",
"attributes": {
"logo": {
"href": "/cms/images/payment-method-vendors/mastercard.png",
"variants": [
{
"dark": {
"href": "/cms/images/payment-method-vendors/mastercard-dark.png"
}
}
]
},
"name": "Mastercard",
"slug": "mastercard"
}
},
{
"id": "33331f72-a672-453c-9d36-d5809ef0ded6",
"type": "paymentMethodKind",
"attributes": {
"name": "SEPA direct debit",
"fuelcard": false,
"implicit": true,
"twoFactor": true,
"vendorPRNs": [
"prn:cms:payment-method-vendors:3af4b4a7-33fc-4930-9c2d-6eea7e488398",
"prn:cms:payment-method-vendors:d546bbe8-e707-43ae-8345-0709e30e710f"
]
}
}
]
}
{
"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": {}
}
]
}
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}