Register a Hoyer Card as a payment method
By registering you allow the user to use a Hoyer Card as a payment method. The payment method ID is optional when posting data.
Responses
-
201 application/vnd.api+json
Created
-
Already exists
-
400 application/vnd.api+json
Bad request
-
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
-
409 application/vnd.api+json
Resource conflicts
-
415 application/vnd.api+json
The specified content type header is invalid
-
422 application/vnd.api+json
The request was well-formed but was unable to be followed due to semantic errors. The following codes may be seen:
provider:card-not-usable
: The card is rejected by the payment provider, e.g., fuelcard deactivatedprovider:invalid-content
: One or more fields of the payment method is not accepted by the payment provider.invalid-charset
: The fields charset is not latintoo-long
: The fields content is too long
-
500 application/vnd.api+json
Internal server error
POST /payment-methods/hoyer
curl \
-X POST https://api.pace.cloud/pay/2024-3/payment-methods/hoyer \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/vnd.api+json"
Request examples
{
"data": {
"id": "2a1319c3-c136-495d-b59a-47b3246d08af",
"type": "paymentMethod",
"attributes": {
"kind": "hoyer",
"cardNumber": "451049",
"pin": "0000",
"managed": true
}
}
}
Response examples (201)
{
"data": {
"id": "fc900b1f-97fc-4c9c-92de-e6d2f2dcc554",
"type": "paymentMethod",
"attributes": {
"kind": "hoyer",
"identificationString": "Hoyer Card XX 123"
}
}
}
Response examples (400)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (401)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (406)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (409)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (415)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (422)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}
Response examples (500)
{
"errors": [
{
"id": "string",
"links": {
"about": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}