> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://useroot.docs.buildwithfern.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://useroot.docs.buildwithfern.com/_mcp/server.

# Add card payment method

POST https://api.useroot.com/api/payees/{payee_id}/payment-methods/push-to-card
Content-Type: application/json

Adds a new card payment method for a payee. Supports push-to-card payments with card number and expiry details.

**Path Parameters**

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payee_id` | UUID | Yes | ID of the payee to add the payment method to |


**Request Body**

| Field | Type | Required | Description | Validation Rules |
|-------|------|----------|-------------|-----------------|
| `card_number` | String | Yes | Card number | Must contain only digits (0-9). Must pass Luhn check |
| `card_expiry_date` | String | Yes | Card expiry date in YYMM format | Must be 4 digits. Must be a future date |

**Response Body**

| Field | Type | Description |
|-------|------|-------------|
| `id` | UUID | Unique identifier for the payment method |
| `payee_id` | UUID | ID of the payee associated with the payment method |
| `card_last_four` | String | Last four digits of the card number (for cards) |
| `card_expiry_date` | String | Expiry date of the card in YYMM format (for cards) |
| `currency_code` | String | ISO 4217 currency code. Always `USD` — card payments are US-only. |
| `country_code` | String | ISO 3166-1 alpha-2 country code. Always `US` — card payments are US-only. |
| `verification_status` | String | Current verification status |
| `is_default` | Boolean | Whether this is the default payment method for the payee |
| `supported_rails` | Array | List of supported payment rails for this payment method |
| `created_at` | DateTime | Timestamp when the payment method was created |
| `updated_at` | DateTime | Timestamp when the payment method was last updated |
| `warning` | String | Optional. Present on 207 responses when the payment method was created but not set as default |

**Success Responses**

| Status Code | Description |
|-------------|-------------|
| 201 | Created - The payment method was successfully added and set as default (if requested) |
| 207 | Multi-Status - The payment method was created but not set as default because verification is pending or failed. Check `warning` for details. Clients may retry setting as default after verification completes. |

**Error Responses**

| Status Code | Error Code | Description |
|-------------|------------|-------------|
| 400 | CARD_VERIFICATION_FAILED | Card type not supported (e.g. credit instead of debit). User should provide a debit card. |
| 400 | VALIDATION_ERROR | The provided data failed validation |
| 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or missing |
| 403 | AUTHORIZATION_ERROR | You do not have permission to perform this action |
| 404 | NOT_FOUND | The specified payee was not found |
| 409 | DUPLICATE_RESOURCE | A payment method with these details already exists |
| 422 | INVALID_PAYMENT_DETAILS | The payment details are invalid or incomplete |
| 503 | CARD_VERIFICATION_SERVICE_ERROR | Card verification service (tokenization, lookup) temporarily unavailable. **Retry with exponential backoff.** |

Reference: https://useroot.docs.buildwithfern.com/api-reference/payment-methods-api/payee-payment-methods-api/add-payee-card-payment-method

## Authentication

- `x-api-key` header (required) — RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

## Request

### Path parameters

- `payee_id` (string, required)

### Query parameters

- `is_default` (boolean, optional, default: true) — Whether to set this payment method as default

### Body (application/json)

- `card_number` (string, required)
- `card_expiry_date` (string, required)
- `country_code` (enum, optional) — Country associated with this card payment method (ISO 3166-1 alpha-2)
  - Allowed values: `US`, `GB`, `IN`

## Response

### 201

Card payment method created successfully

- `data` (object, required)
  - `created_at` (datetime, required)
  - `updated_at` (datetime, required)
  - `id` (string, required)
  - `payee_id` (string, required)
  - `card_last_four` (string, required)
  - `card_expiry_date` (string, required)
  - `currency_code` (enum, required)
    - Allowed values: `USD`, `GBP`, `INR`
  - `country_code` (enum, required)
    - Allowed values: `US`, `GB`, `IN`
  - `is_default` (boolean, required)
  - `supported_rails` (list of enum, required)
    - Allowed values: `instant_card`, `instant_bank`, `same_day_ach`, `standard_ach`, `wire`, `{'instant_card', 'instant_bank'}`, `{'standard_ach', 'same_day_ach'}`, `{'standard_ach', 'wire'}`
  - `verification_status` (enum, required)
    - Allowed values: `verified`, `pending`, `failed`
  - `warning` (string, optional, nullable)
- `warning` (string, optional, nullable)

### 207

Card payment method created but not set as default due to verification status

## Examples

### United States debit card

**Request**

```json
{
  "card_number": "4111111111111111",
  "card_expiry_date": "2512",
  "country_code": "US"
}
```

**Response**

```json
{
  "data": {
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "payee_id": "987e6543-c21b-43a5-a987-654321098765",
    "card_last_four": "1111",
    "card_expiry_date": "2512",
    "currency_code": "USD",
    "country_code": "US",
    "is_default": false,
    "supported_rails": [
      "instant_card"
    ],
    "verification_status": "verified"
  }
}
```

**SDK Code**

```python United States debit card
import requests

url = "https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card"

payload = {
    "card_number": "4111111111111111",
    "card_expiry_date": "2512",
    "country_code": "US"
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript United States debit card
const url = 'https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"card_number":"4111111111111111","card_expiry_date":"2512","country_code":"US"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go United States debit card
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card"

	payload := strings.NewReader("{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby United States debit card
require 'uri'
require 'net/http'

url = URI("https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}"

response = http.request(request)
puts response.read_body
```

```java United States debit card
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}")
  .asString();
```

```php United States debit card
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card', [
  'body' => '{
  "card_number": "4111111111111111",
  "card_expiry_date": "2512",
  "country_code": "US"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp United States debit card
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift United States debit card
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "card_number": "4111111111111111",
  "card_expiry_date": "2512",
  "country_code": "US"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Unverified debit card

**Request**

```json
{
  "card_number": "4111111111111111",
  "card_expiry_date": "2512",
  "country_code": "US"
}
```

**Response**

```json
{
  "data": {
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "payee_id": "987e6543-c21b-43a5-a987-654321098765",
    "card_last_four": "1111",
    "card_expiry_date": "2512",
    "currency_code": "USD",
    "country_code": "US",
    "is_default": false,
    "supported_rails": [
      "instant_card"
    ],
    "verification_status": "pending",
    "warning": "Payment method was created but not set as default because it is not verified"
  }
}
```

**SDK Code**

```python Unverified debit card
import requests

url = "https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card"

payload = {
    "card_number": "4111111111111111",
    "card_expiry_date": "2512",
    "country_code": "US"
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Unverified debit card
const url = 'https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"card_number":"4111111111111111","card_expiry_date":"2512","country_code":"US"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Unverified debit card
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card"

	payload := strings.NewReader("{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Unverified debit card
require 'uri'
require 'net/http'

url = URI("https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}"

response = http.request(request)
puts response.read_body
```

```java Unverified debit card
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}")
  .asString();
```

```php Unverified debit card
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card', [
  'body' => '{
  "card_number": "4111111111111111",
  "card_expiry_date": "2512",
  "country_code": "US"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Unverified debit card
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Unverified debit card
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "card_number": "4111111111111111",
  "card_expiry_date": "2512",
  "country_code": "US"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Unverified debit card

**Request**

```json
{
  "card_number": "4111111111111111",
  "card_expiry_date": "2512",
  "country_code": "US"
}
```

**Response**

```json
{
  "data": {
    "created_at": "2024-03-20T12:00:00Z",
    "updated_at": "2024-03-20T12:00:00Z",
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "payee_id": "987e6543-c21b-43a5-a987-654321098765",
    "card_last_four": "1111",
    "card_expiry_date": "2512",
    "currency_code": "USD",
    "country_code": "US",
    "is_default": false,
    "supported_rails": [
      "instant_card"
    ],
    "verification_status": "pending",
    "warning": "Payment method was created but not set as default because it is not verified"
  }
}
```

**SDK Code**

```python Unverified debit card
import requests

url = "https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card"

payload = {
    "card_number": "4111111111111111",
    "card_expiry_date": "2512",
    "country_code": "US"
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Unverified debit card
const url = 'https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"card_number":"4111111111111111","card_expiry_date":"2512","country_code":"US"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Unverified debit card
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card"

	payload := strings.NewReader("{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Unverified debit card
require 'uri'
require 'net/http'

url = URI("https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}"

response = http.request(request)
puts response.read_body
```

```java Unverified debit card
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}")
  .asString();
```

```php Unverified debit card
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card', [
  'body' => '{
  "card_number": "4111111111111111",
  "card_expiry_date": "2512",
  "country_code": "US"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Unverified debit card
using RestSharp;

var client = new RestClient("https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"card_number\": \"4111111111111111\",\n  \"card_expiry_date\": \"2512\",\n  \"country_code\": \"US\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Unverified debit card
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "card_number": "4111111111111111",
  "card_expiry_date": "2512",
  "country_code": "US"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.useroot.com/api/payees/payee_id/payment-methods/push-to-card")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```