Sign in

v1

latestOpenAPI 3.0.12026-07-24256962.9 KB
Payment Methods

Retrieve a Payment Method

get/payment-methods/{id}

Path parameters

idstring uuid required

The ID of the Payment Method

Query parameters

payerIdstring uuid required

The Payer ID associated to the Payment Method

Headers

Trace-Idstring

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agentstring

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ipstring

The IP address of the end user. Recommended for compliance.

End-User-OSstring

The Operating System of the end user. Recommended for compliance.

End-User-Device-Idstring

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturerstring

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Modelstring

The device model used by the end user. Recommended for compliance.

Response

A Payment Method object

idstring uuid
externalIdstring

Consumer defined ID that will be attached to this resource

type'CARD' | 'BANK_ACCOUNT'
status'ACTIVE' | 'INACTIVE'

In some cases Payment Method will remain Inactive until additional information provided

Example response

{
  "id": "6f0eb884-3f41-4b57-b86a-80f62dca011e",
  "data": {
    "last4": "4242",
    "brand": "Visa",
    "expirationMonth": "01",
    "expirationYear": "2021",
    "createdAt": "2020-11-19T01:35:53.096Z",
    "billingAddress": {
      "line1": "360 9th St.",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94103",
      "country": "US"
    },
    "subType": "CREDIT"
  },
  "status": "INACTIVE",
  "statusReasons": [
    {
      "code": "STATUS_REASON_CODE",
      "message": "Some message to help resolve status issue."
    }
  ]
}