Listar perfis de pagamento


Use this endpoint to list payment profiles saved to your account.

Example requests and responses

curl -X GET \ \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
import requests

url = ""

payload = ""
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"

response = requests.request("GET", url, data=payload, headers=headers)

package main

import (

func main() {

	url := ""

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)


var request = require("request");

var options = { method: 'GET',
  url: '',
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

200 OK
  "profiles": [
      "id": 1001,
      "is_default": true,
      "status": "active",
      "credit_card": {
        "shortened_number": "1234",
        "type": "amex",
        "expiration_month": 1,
        "expiration_year": 2055,
        "cardholder_name": "John Fake",
        "label": "Buisness Amex - 1234"
      "billing_address": {
        "address": "123 Fake Street",
        "city": "Lehi",
        "state": "ut",
        "zip": "84043",
        "country": "us"
      "billing_email": ""
  "page": {
    "total": 1,
    "limit": 1000,
    "offset": 0

Filters and URL query parameters

This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see Services API - Filters, sorting, and pagination parameters.

Name Req/Opt Type Description
filters[{{property_name}}] optional string Filters results by the specified property.

Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports filtering by the following properties:
  • filters[status] – Use active, inactive, or all.
sort optional string Sorts results by the value of one or more properties.

By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus (-).

To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list.

This endpoint supports sorting by the following properties:
  • id
  • status
  • credit_card.expiration_year
  • credit_card.cardholder_name
limit optional int Total number of results to include in the response.
Max: 1000 (default)
offset optional int Index of the first result to include in the response.
Default: 0

Response parameters

Name Type Description
profiles array List of saved payment profiles.
.. id int Payment profile ID.
.. is_default bool Specifies if it is the default payment profile.
.. status string Status of the payment profile.
Possible values: active, inactive
.. credit_card object Details about the saved credit card.
.. .. shortened_number string Last four digits of the saved credit card.
.. .. type string Credit card issuer.
Possible values: amex, discover, mastercard, visa, other
.. .. expiration_month int Expiration month of the credit card.
.. .. expiration_year int Expiration year of the credit card.
.. .. cardholder_name string Name on the credit card.
.. .. label string Short description of the card.
.. billing_address object Details about the billing address for the saved payment profile.
.. .. address string
.. .. city string
.. .. state string
.. .. zip string
.. .. country string
.. billing_email string Email address for the saved payment profile.
page object Details about results.
Modified using URL query strings.