Retrieve a Payment Method

GET/api/paymentmethod/{identifier}

This endpoint retrieves the details of a payment method using its unique identifier. The response includes information such as the merchant, customer, and billing details associated with the payment method.

Path Parameters

identifierstringrequired

Response

A successful response containing the payment method details.

resultobject

The result of the payment method retrieval request, including the status and any relevant messages.

Show result properties

The type of result indicating the status of the request.

merchantMessagestring

A message intended for the merchant, providing additional details about the result of the request.

logIdentifierstring

A unique identifier for the server log entry related to this request, useful for troubleshooting.

logAsErrorboolean

Indicates whether this log entry should be treated as an error.

merchantIdentifierstring

The unique identifier for the merchant associated with this payment method.

customerIdentifierstring

The unique identifier for the customer, if available.

customerReferencestring

A reference provided by the merchant to identify the customer associated with the payment method.

paymentMethodIdentifierstring

The unique identifier for the payment method.

cardobject

The details of the credit card associated with this payment method.

Show card properties

cardNumberstring

The credit card number. This field is optional and should be stored securely.

expiryMonthinteger<int32>

The expiry month of the credit card.

expiryYearinteger<int32>

The expiry year of the credit card.

cardHolderNamestring

The name of the cardholder as it appears on the credit card.

cvvstring

The card verification value (CVV) for the credit card. This field is optional.

The brand of the credit card, such as Visa or MasterCard.

billingInformationobject

The billing information associated with the payment method, including address details.

Show billingInformation properties

firstLinestring

The first line of the billing address.

secondLinestring

The second line of the billing address.

citystring

The city of the billing address.

regionstring

The region or state of the billing address.

zipCodestring

The postal or ZIP code of the billing address.

countryAlpha3Codestring

The three-letter country code (ISO Alpha-3) for the billing address.

countryIdinteger<int64>

The unique identifier for the country.

The request is invalid or contains incorrect parameters.

resultobject

The result object that contains the outcome and additional details of the API request.

Show result properties

The type of result indicating the status of the request.

merchantMessagestring

A message intended for the merchant, providing additional details about the result of the request.

logIdentifierstring

A unique identifier for the server log entry related to this request, useful for troubleshooting.

logAsErrorboolean

Indicates whether this log entry should be treated as an error.

Unauthorized request. Authentication is required.

Access is forbidden due to insufficient permissions.

The requested payment method was not found.

resultobject

The result object that contains the outcome and additional details of the API request.

Show result properties

The type of result indicating the status of the request.

merchantMessagestring

A message intended for the merchant, providing additional details about the result of the request.

logIdentifierstring

A unique identifier for the server log entry related to this request, useful for troubleshooting.

logAsErrorboolean

Indicates whether this log entry should be treated as an error.