POST
/
payments
/
payees
Create a new payee
curl --request POST \
  --url https://agent.payman.ai/api/payments/payees \
  --header 'Content-Type: application/json' \
  --header 'x-payman-api-secret: <api-key>' \
  --data '{
  "type": "CRYPTO_ADDRESS",
  "address": "<string>",
  "chain": "<string>",
  "currency": "<string>",
  "name": "<string>",
  "tags": [
    "<string>"
  ],
  "contactDetails": {
    "email": "<string>",
    "phoneNumber": "<string>",
    "address": {
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "addressLine3": "<string>",
      "addressLine4": "<string>",
      "locality": "<string>",
      "region": "<string>",
      "postcode": "<string>",
      "country": "<string>"
    },
    "taxId": "<string>"
  }
}'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "providerInfo": {},
  "name": "<string>",
  "organizationId": "<string>",
  "tags": [
    "<string>"
  ],
  "type": "US_ACH",
  "payeeDetails": {},
  "contactDetails": {
    "email": "<string>",
    "phoneNumber": "<string>",
    "address": {
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "addressLine3": "<string>",
      "addressLine4": "<string>",
      "locality": "<string>",
      "region": "<string>",
      "postcode": "<string>",
      "country": "<string>"
    },
    "taxId": "<string>"
  },
  "status": "ACTIVE",
  "searchHashes": {},
  "replacesId": "<string>"
}

Payment Destination Types

  • US_ACH - US Bank Account
  • CRYPTO_ADDRESS - Cryptocurrency Address
  • PAYMAN_WALLET - Payman Wallet (Coming Soon)

Authorizations

x-payman-api-secret
string
header
required

Body

application/json

A cryptocurrency address-based payee

type
enum<string>
required

The type of payee

Available options:
CRYPTO_ADDRESS
address
string
required

The cryptocurrency address to send funds to

chain
string
required

The the blockchain to use for the transaction

currency
string
required

The the currency/token to use for the transaction

name
string
required

The name you wish to associate with this payee for future lookups.

tags
string[]

Any additional labels you wish to assign to this payee

Any additional labels you wish to assign to this payee

contactDetails
object

Contact details for this payee

Response

The payment was successful.

name
string
required

The user-assigned name of the payee

organizationId
string
required
type
enum<string>
required

The type of payee

Available options:
US_ACH,
CRYPTO_ADDRESS,
PAYMAN_WALLET,
TEST_RAILS
id
string
createdAt
string<date-time>
updatedAt
string<date-time>
createdBy
string
updatedBy
string
providerInfo
object
tags
string[]

Tags to help categorize the payee

Tags to help categorize the payee

payeeDetails
object
contactDetails
object

Contact details for this payee

status
enum<string>

The status of the payee

Available options:
ACTIVE,
ARCHIVED,
DELETED
searchHashes
object
replacesId
string

The ID of the payee this entity replaces