Update recipient

curl --request PATCH \
  --url https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId} \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "jason.treasury@swipelux.com",
  "label": "Treasury payout profile"
}
'

import requests

url = "https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}"

payload = {
    "email": "jason.treasury@swipelux.com",
    "label": "Treasury payout profile"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({email: 'jason.treasury@swipelux.com', label: 'Treasury payout profile'})
};

fetch('https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}', 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://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jason.treasury@swipelux.com',
    'label' => 'Treasury payout profile'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-API-Key: <api-key>"
  ],
]);

$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://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}"

	payload := strings.NewReader("{\n  \"email\": \"jason.treasury@swipelux.com\",\n  \"label\": \"Treasury payout profile\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	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.patch("https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jason.treasury@swipelux.com\",\n  \"label\": \"Treasury payout profile\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}")

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

request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jason.treasury@swipelux.com\",\n  \"label\": \"Treasury payout profile\"\n}"

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

{
  "data": {
    "id": "rcp_6dV8xN2pQ4rT7mA9sL1k",
    "customerId": "cus_uPlL04SqhMf8QYHcJV",
    "status": "active",
    "type": "individual",
    "relationship": "contractor",
    "firstName": "Jason",
    "lastName": "Swipelux",
    "email": "jason.treasury@swipelux.com",
    "phone": "+14155551234",
    "address": {
      "streetLine1": "1 Market Street",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94105",
      "country": "US"
    },
    "label": "Treasury payout profile",
    "createdAt": "2026-06-25T12:00:00.000Z",
    "updatedAt": "2026-06-25T12:05:00.000Z",
    "archivedAt": null
  }
}

{
  "type": "https://docs.swipelux.com/errors/validation-error",
  "title": "<string>",
  "status": 400,
  "code": "validation_error",
  "detail": "<string>",
  "correlationId": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/unauthorized",
  "title": "<string>",
  "status": 401,
  "code": "unauthorized",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/forbidden",
  "title": "<string>",
  "status": 403,
  "code": "forbidden",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/not-found",
  "title": "<string>",
  "status": 404,
  "code": "not_found",
  "detail": "<string>",
  "correlationId": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/idempotency-conflict",
  "title": "<string>",
  "status": 409,
  "code": "idempotency_conflict",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/internal-error",
  "title": "<string>",
  "status": 500,
  "code": "internal_error",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": true,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Update recipient

curl --request PATCH \
  --url https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId} \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "jason.treasury@swipelux.com",
  "label": "Treasury payout profile"
}
'

import requests

url = "https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}"

payload = {
    "email": "jason.treasury@swipelux.com",
    "label": "Treasury payout profile"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({email: 'jason.treasury@swipelux.com', label: 'Treasury payout profile'})
};

fetch('https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}', 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://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jason.treasury@swipelux.com',
    'label' => 'Treasury payout profile'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-API-Key: <api-key>"
  ],
]);

$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://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}"

	payload := strings.NewReader("{\n  \"email\": \"jason.treasury@swipelux.com\",\n  \"label\": \"Treasury payout profile\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	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.patch("https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jason.treasury@swipelux.com\",\n  \"label\": \"Treasury payout profile\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.swipelux.com/v3/customers/{customerId}/recipients/{recipientId}")

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

request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jason.treasury@swipelux.com\",\n  \"label\": \"Treasury payout profile\"\n}"

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

{
  "data": {
    "id": "rcp_6dV8xN2pQ4rT7mA9sL1k",
    "customerId": "cus_uPlL04SqhMf8QYHcJV",
    "status": "active",
    "type": "individual",
    "relationship": "contractor",
    "firstName": "Jason",
    "lastName": "Swipelux",
    "email": "jason.treasury@swipelux.com",
    "phone": "+14155551234",
    "address": {
      "streetLine1": "1 Market Street",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94105",
      "country": "US"
    },
    "label": "Treasury payout profile",
    "createdAt": "2026-06-25T12:00:00.000Z",
    "updatedAt": "2026-06-25T12:05:00.000Z",
    "archivedAt": null
  }
}

{
  "type": "https://docs.swipelux.com/errors/validation-error",
  "title": "<string>",
  "status": 400,
  "code": "validation_error",
  "detail": "<string>",
  "correlationId": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/unauthorized",
  "title": "<string>",
  "status": 401,
  "code": "unauthorized",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/forbidden",
  "title": "<string>",
  "status": 403,
  "code": "forbidden",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/not-found",
  "title": "<string>",
  "status": 404,
  "code": "not_found",
  "detail": "<string>",
  "correlationId": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/idempotency-conflict",
  "title": "<string>",
  "status": 409,
  "code": "idempotency_conflict",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/internal-error",
  "title": "<string>",
  "status": 500,
  "code": "internal_error",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": true,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Headers

Idempotency-Key

string

required

Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response.

Required string length: 1 - 255

Path Parameters

customerId

string

required

recipientId

string

required

Body

application/json

relationship

enum<string>

Available options:

employee,

contractor,

vendor,

subsidiary,

merchant,

customer,

landlord,

family,

other

firstName

string

Minimum string length: 1

lastName

string

Minimum string length: 1

companyName

string

Minimum string length: 1

businessIndustry

string

6-digit NAICS code used for provider-backed ACH readiness checks on business recipients.

Required string length: 6

Pattern: ^\d{6}$

string<email>

phone

string

address

object

Show child attributes

label

string

Maximum string length: 255

metadata

object

Show child attributes

Response

Recipient updated

data

object

required

Option 1
Option 2

Show child attributes

Overview

Versioning

Endpoints

Update recipient

Authorizations

Headers

Path Parameters

Body

Response