GET
/
paymentMethods
/
{paymentMethodId}
curl --request GET \
  --url https://prod.api.palomma.com/v1/paymentMethods/{paymentMethodId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "67d7ae28-bf1d-4ee9-8a47-99358c9e6c32",
  "status": "active",
  "customerId": "e79a0b74-3aba-4149-9f74-0bb5791a6ee6",
  "customerDetails": {
    "name": "Pepito Perez",
    "documentType": "cc",
    "documentNumber": "200220422",
    "email": "pepito@perez.com"
  },
  "type": "bankAccount",
  "bankAccount": {
    "bank": "santander",
    "accountType": "savings",
    "accountNumber": "123456789"
  },
  "bancolombiaInstant": {
    "authUrl": "https://www.bancolombia.com/...",
    "affiliate": {
      "name": "Pepito Perez",
      "documentType": "cc",
      "documentNumber": "200220422",
      "accountType": "savings",
      "accountNumber": "123456789"
    }
  },
  "nequiInstant": {
    "phoneNumber": "3298779391"
  },
  "createdAt": "2023-10-26T21:28:34.152Z",
  "updatedAt": "2023-10-26T21:28:34.152Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
paymentMethodId
string
required

Unique identifier of the payment method.

Response

200
application/json
Payment Method retrieved successfully.
​
id
string

Unique identifier for this payment method.

Example:

"67d7ae28-bf1d-4ee9-8a47-99358c9e6c32"

​
status
enum<string>

Status of the payment method. 'pending' indicates the payment method is not yet available for payment requests. 'active' indicates the payment method is available for payment requests. 'error' indicates an error confirming the bank account, usually when bank info is incorrect or customer info doesn’t match with the bank account owner’s.

Available options:
pending,
active,
error
Example:

"active"

​
customerId
string

Reference to the customer who owns this payment method.

Example:

"e79a0b74-3aba-4149-9f74-0bb5791a6ee6"

​
customerDetails
object
​
type
enum<string>

Type of payment method created. Can be "bankAccount" for an account that transacts through traditional slower banking rails, "bancolombiaInstant", or "nequiInstant" for tokenized instant payment accounts.

Available options:
bankAccount,
bancolombiaInstant,
nequiInstant
Example:

"bankAccount"

​
bankAccount
object
​
bancolombiaInstant
object
​
nequiInstant
object
​
createdAt
string

ISO string when the payment method was created.

Example:

"2023-10-26T21:28:34.152Z"

​
updatedAt
string

ISO string when the payment method was last updated.

Example:

"2023-10-26T21:28:34.152Z"