Skip to main content
GET
/
api
/
canary
/
payment-methods
/
{id}
Retrieve Payment Method
curl --request GET \
  --url https://api.cashful.africa/api/canary/payment-methods/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "pm_001",
  "customerId": "customer_789",
  "type": "card",
  "provider": "iveri",
  "brand": "visa",
  "last4": "4242",
  "expiryMonth": 12,
  "expiryYear": 2027,
  "phoneNumber": null,
  "isDefault": true,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "updatedAt": "2025-01-15T10:30:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The unique identifier of the payment method

Response

Successfully retrieved payment method details

​
id
string
required

Unique payment method identifier

​
customerId
string
required

Customer ID this payment method belongs to

​
type
string
required

Payment method type (e.g., card, mobile_money)

​
provider
string
required

Payment provider name (e.g., iveri, mpesa)

​
isDefault
boolean
required

Whether this is the default payment method

​
createdAt
string<date-time>
required

When the payment method was created

​
updatedAt
string<date-time>
required

When the payment method was last updated

​
brand
string

Card brand (e.g., Visa, Mastercard)

​
last4
string

Last 4 digits of card number

​
expiryMonth
number

Card expiry month (1-12)

​
expiryYear
number

Card expiry year

​
phoneNumber
string

Phone number for mobile money