Create Payment Method
curl --request POST \
--url https://api.example.com/api/v1/customer/payment-methods \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cardToken": "pm_1NXYzABC123",
"isDefault": false
}
'import requests
url = "https://api.example.com/api/v1/customer/payment-methods"
payload = {
"cardToken": "pm_1NXYzABC123",
"isDefault": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({cardToken: 'pm_1NXYzABC123', isDefault: false})
};
fetch('https://api.example.com/api/v1/customer/payment-methods', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/customer/payment-methods",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cardToken' => 'pm_1NXYzABC123',
'isDefault' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/customer/payment-methods"
payload := strings.NewReader("{\n \"cardToken\": \"pm_1NXYzABC123\",\n \"isDefault\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/customer/payment-methods")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cardToken\": \"pm_1NXYzABC123\",\n \"isDefault\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/payment-methods")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cardToken\": \"pm_1NXYzABC123\",\n \"isDefault\": false\n}"
response = http.request(request)
puts response.read_body{
"paymentMethodId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
"customerId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "CREDIT_CARD",
"isDefault": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"externalProvider": "in_memory",
"externalProviderId": "pm_abc123def456",
"card": {
"brand": "VISA",
"last4": "4242"
},
"createdBy": null,
"updatedBy": null
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Internal Server Error",
"statusCode": 500
}Payment Method
Create Payment Method
Creates a payment method.
POST
/
api
/
v1
/
customer
/
payment-methods
Create Payment Method
curl --request POST \
--url https://api.example.com/api/v1/customer/payment-methods \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cardToken": "pm_1NXYzABC123",
"isDefault": false
}
'import requests
url = "https://api.example.com/api/v1/customer/payment-methods"
payload = {
"cardToken": "pm_1NXYzABC123",
"isDefault": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({cardToken: 'pm_1NXYzABC123', isDefault: false})
};
fetch('https://api.example.com/api/v1/customer/payment-methods', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/customer/payment-methods",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cardToken' => 'pm_1NXYzABC123',
'isDefault' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/customer/payment-methods"
payload := strings.NewReader("{\n \"cardToken\": \"pm_1NXYzABC123\",\n \"isDefault\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/customer/payment-methods")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cardToken\": \"pm_1NXYzABC123\",\n \"isDefault\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/customer/payment-methods")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cardToken\": \"pm_1NXYzABC123\",\n \"isDefault\": false\n}"
response = http.request(request)
puts response.read_body{
"paymentMethodId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
"customerId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "CREDIT_CARD",
"isDefault": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"externalProvider": "in_memory",
"externalProviderId": "pm_abc123def456",
"card": {
"brand": "VISA",
"last4": "4242"
},
"createdBy": null,
"updatedBy": null
}{
"errors": [
{
"message": "required",
"path": "name"
}
],
"message": "Bad Request Error",
"statusCode": 400
}{
"message": "Missing or invalid access token",
"statusCode": 401
}{
"message": "Internal Server Error",
"statusCode": 500
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.
Body
application/json
Response
Created
Payment method
Payment method identifier
Example:
"f1a2b3c4-d5e6-7890-abcd-ef1234567890"
Customer identifier
Example:
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
Payment method type
Available options:
CASH, PIX, CREDIT_CARD, DEBIT_CARD Example:
"CREDIT_CARD"
Whether this is the default method
Example:
true
Created at
Example:
"2026-01-01T00:00:00.000Z"
Updated at
Example:
"2026-01-01T00:00:00.000Z"
Payment gateway provider
Example:
"in_memory"
Identifier in the payment gateway
Example:
"pm_abc123def456"
Card details
Show child attributes
Show child attributes
Created by
Example:
null
Updated by
Example:
null