Paxos API v1.0 (DEPRECATED)
Scroll down for example requests and responses.
Production Endpoints:
- OAuth2 Authentication: https://oauth.paxos.com
- API: https://api.paxos.com
Other Formats:
Authentication
-
oAuth2 authentication. The Paxos API uses OAuth2 and access is limited to a subset of OAuth2 scopes. First-party integrations for a single customer is supported, and must authenticate through OAuth2's client credentials flow. Please read our full Authentication Guide for implementation details.
- Flow: authorizationCode
- Authorization URL = https://oauth.paxos.com/oauth2/auth
- Token URL = https://oauth.paxos.com/oauth2/token
| Scope | Scope Description |
|---|---|
| kyc:read_customer_status | read customer account information and status |
| funding:write_profile | create and update sub-accounts (first party only) |
| funding:read_profile | read sub-accounts (first party only) |
| funding:read_activity | read transaction history |
| funding:write_bank_account | create and update bank account info |
| funding:read_bank_account | read bank account info |
| funding:internal_transfer | create an internal transfer from one profile to another on the same customer |
| funding:account_to_account_transfer | create a transfer from one profile to another for any customer |
| funding:withdraw_fiat | withdraw fiat from the paxos platform (first party only) |
| funding:withdraw_crypto | withdraw crypto from the paxos platform (first party only) |
| funding:read_address | read info on crypto addresses |
| funding:write_address | create and update crypto addresses |
| funding:read_token_value | read value of a token (first party only) |
FundingPublic
GetActivities
GET /v1/activities
Read the transaction history associated with the end-customer's Paxos account. Returns information on deposits and withdrawals of crypto-assets and fiat currency. Apply filters as necessary.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pagination.limit | query | integer(int32) | false | Number of results to return |
| pagination.offset | query | integer(int32) | false | Number of results to skip |
| assetType | query | string | false | none |
| activityType | query | array[string] | false | none |
| profileId | query | string | false | none |
| activityStatus | query | array[string] | false | none |
| externalId | query | string | false | none |
| createdRange.begin | query | string(date-time) | false | Only return records after this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z. |
| createdRange.end | query | string(date-time) | false | Only return records before this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z. |
| updatedRange.begin | query | string(date-time) | false | Only return records after this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z. |
| updatedRange.end | query | string(date-time) | false | Only return records before this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z. |
| orderingPolicy | query | string | false | none |
Enumerated Values
| Parameter | Value |
|---|---|
| assetType | USD |
| assetType | BTC |
| assetType | ETH |
| assetType | PAX |
| assetType | PAXG |
| assetType | UNALLOCATED_GOLD |
| assetType | ALLOCATED_GOLD |
| assetType | BUSD |
| assetType | HUSD |
| assetType | EUR |
| assetType | SGD |
| assetType | BCH |
| assetType | LTC |
| assetType | USDP |
| assetType | AAVE |
| assetType | UNI |
| assetType | MATIC |
| assetType | PYUSD |
| assetType | LINK |
| assetType | SOL |
| activityType | SEND_PROFILE_TRANSFER |
| activityType | RECV_PROFILE_TRANSFER |
| activityType | CRYPTO_DEPOSIT |
| activityType | CRYPTO_WITHDRAWAL |
| activityType | WIRE_DEPOSIT |
| activityType | WIRE_WITHDRAWAL |
| activityType | SEN_DEPOSIT |
| activityType | SEN_WITHDRAWAL |
| activityType | PAXOS_CREDIT |
| activityType | PAXOS_DEBIT |
| activityType | BANK_DEPOSIT |
| activityType | BANK_WITHDRAWAL |
| activityType | UNALLOCATED_GOLD_DEPOSIT |
| activityType | UNALLOCATED_GOLD_WITHDRAWAL |
| activityType | ALLOCATED_GOLD_WITHDRAWAL |
| activityType | TOKEN_ORDER |
| activityType | TO_ITBIT_TRANSFER |
| activityType | FROM_ITBIT_TRANSFER |
| activityType | SEND_PEER_TRANSFER |
| activityType | RECV_PEER_TRANSFER |
| activityType | ADMIN_SEND_PEER_TRANSFER |
| activityType | ADMIN_RECV_PEER_TRANSFER |
| activityType | SIGNET_DEPOSIT |
| activityType | SIGNET_WITHDRAWAL |
| activityType | CBIT_WITHDRAWAL |
| activityType | CBIT_DEPOSIT |
| activityStatus | COMPLETE |
| activityStatus | PENDING |
| activityStatus | ERRORED |
| activityStatus | CANCELLED |
| orderingPolicy | CREATED_AT_DESC |
| orderingPolicy | CREATED_AT_ASC |
Example responses
200 Response
{
"type": "object",
"properties": {
"activities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
},
"count": {
"type": "integer",
"format": "int32"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | GetActivitiesResponse |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
GetActivity
GET /v1/activities/{id}
Use {id} to return the transaction details for a specific customer activity (deposit/withdrawal).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | Activity |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
ListAutoConversions
GET /v1/auto-conversions
Returns auto-conversion history.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| deposit.activityType | query | string | false | none |
| deposit.txId | query | string | false | Raw txHash |
Enumerated Values
| Parameter | Value |
|---|---|
| deposit.activityType | SEND_PROFILE_TRANSFER |
| deposit.activityType | RECV_PROFILE_TRANSFER |
| deposit.activityType | CRYPTO_DEPOSIT |
| deposit.activityType | CRYPTO_WITHDRAWAL |
| deposit.activityType | WIRE_DEPOSIT |
| deposit.activityType | WIRE_WITHDRAWAL |
| deposit.activityType | SEN_DEPOSIT |
| deposit.activityType | SEN_WITHDRAWAL |
| deposit.activityType | PAXOS_CREDIT |
| deposit.activityType | PAXOS_DEBIT |
| deposit.activityType | BANK_DEPOSIT |
| deposit.activityType | BANK_WITHDRAWAL |
| deposit.activityType | UNALLOCATED_GOLD_DEPOSIT |
| deposit.activityType | UNALLOCATED_GOLD_WITHDRAWAL |
| deposit.activityType | ALLOCATED_GOLD_WITHDRAWAL |
| deposit.activityType | TOKEN_ORDER |
| deposit.activityType | TO_ITBIT_TRANSFER |
| deposit.activityType | FROM_ITBIT_TRANSFER |
| deposit.activityType | SEND_PEER_TRANSFER |
| deposit.activityType | RECV_PEER_TRANSFER |
| deposit.activityType | ADMIN_SEND_PEER_TRANSFER |
| deposit.activityType | ADMIN_RECV_PEER_TRANSFER |
| deposit.activityType | SIGNET_DEPOSIT |
| deposit.activityType | SIGNET_WITHDRAWAL |
| deposit.activityType | CBIT_WITHDRAWAL |
| deposit.activityType | CBIT_DEPOSIT |
Example responses
200 Response
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"profileId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"depositAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"withdrawalAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"deposit": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
},
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
},
"withdrawalDestAddressId": {
"type": "string"
},
"withdrawalDestBankAccountId": {
"type": "string"
},
"amount": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"PENDING_DEPOSIT",
"ERROR_DEPOSIT",
"PENDING_WITHDRAWAL",
"ERROR_WITHDRAWAL",
"COMPLETE"
]
}
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | ListAutoConversionsResponse |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
GetBankAccountAutoConversionInstructions
GET /v1/bank-account/{id}/auto-conversion-instructions/{targetAsset}
Returns a specific Paxos-issued deposit address. This address is associated with the bank account where the customer wants their funds sent. Tokens sent to this address will be automatically converted to USD and sent to the corresponding bank account of the customer. Each bank account saved by the user will be assigned its own unique redemption address.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
| targetAsset | path | string | true | none |
| network | query | string | false | none |
Enumerated Values
| Parameter | Value |
|---|---|
| targetAsset | USD |
| targetAsset | BTC |
| targetAsset | ETH |
| targetAsset | PAX |
| targetAsset | PAXG |
| targetAsset | UNALLOCATED_GOLD |
| targetAsset | ALLOCATED_GOLD |
| targetAsset | BUSD |
| targetAsset | HUSD |
| targetAsset | EUR |
| targetAsset | SGD |
| targetAsset | BCH |
| targetAsset | LTC |
| targetAsset | USDP |
| targetAsset | AAVE |
| targetAsset | UNI |
| targetAsset | MATIC |
| targetAsset | PYUSD |
| targetAsset | LINK |
| targetAsset | SOL |
| network | NETWORK_BTC |
| network | NETWORK_ETH |
| network | NETWORK_BCH |
| network | NETWORK_LTC |
| network | NETWORK_SOL |
Example responses
200 Response
{
"type": "object",
"properties": {
"eth": {
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
},
"sol": {
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | GetBankAccountAutoConversionInstructionsResponse |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
ListBankAccounts
GET /v1/bank-accounts
Returns a comprehensive list of bank accounts that have been saved by the customer. Used to enable the customer to designate which bank account they want their funds sent to after token redemption.
Example responses
200 Response
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | ListBankAccountsResponse |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CreateBankAccount
POST /v1/bank-accounts
Creates a new saved bank account for the customer, where the proceeds of a token redemption can be sent.
Body parameter
{
"type": "object",
"properties": {
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "Save a bank account. Specify exactly one instruction type. For example, \"cbit\".",
"required": [
"nickname"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateBankAccountRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CustomerBankAccount |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 409 | Conflict | Already Exists | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
GetBankAccount
GET /v1/bank-accounts/{id}
Returns a single saved bank account of the customer, specified by id.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CustomerBankAccount |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
ArchiveBankAccount
DELETE /v1/bank-accounts/{id}
Removes a specific bank account from the list of accounts previously saved by the customer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
200 Response
{
"type": "object"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | ArchiveBankAccountResponse |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CreateCbitWithdrawal
POST /v1/cbit-withdrawals
Request a withdrawal from a balance at Paxos through CBIT.
Body parameter
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"bankAccountId": {
"type": "string",
"title": "customer bank account"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"description": "If the same `external_id` is supplied in multiple requests, only the first one will go through (idempotence)."
}
},
"required": [
"profileId",
"bankAccountId",
"amount",
"externalId"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateCbitWithdrawalRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CreateCbitWithdrawalResponse |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 404 | Not Found | Not Found | Inline |
| 409 | Conflict | Already Exists | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
ListCryptoAddresses
GET /v1/crypto-addresses
Returns a list of the customer's saved destination addresses, where tokens can be sent.
Example responses
200 Response
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | ListCryptoAddressesResponse |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CreateCryptoAddress
POST /v1/crypto-addresses
Saves the asset-specific deposit address associated with the customer on the partner's platform. This is where tokens will be sent after funding occurs. Depending on the use-case, this can also be used to save additional deposit addresses for that user.
Body parameter
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CustomerCryptoAddress | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CustomerCryptoAddress |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
GetCryptoAddress
GET /v1/crypto-addresses/{id}
Returns a saved destination address of the customer, specified by id.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CustomerCryptoAddress |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
GetCryptoAddressAutoConversionInstructions
GET /v1/crypto-addresses/{id}/auto-conversion-instructions/{targetAsset}
Returns funding instruction options for the auto-creation of Paxos-issued USD-backed tokens, i.e. PAX, BUSD, HUSD. Funding can be done via either fiat-currency, or another Paxos-issued USD-backed token. For fiat-funding, a Memo ID will be provided. If funding with another Paxos-issued USD-backed token, an ETH address will be provided. Funds sent to Paxos using either of these instruction types will be automatically converted to the token requested by the customer and sent to the destination address which corresponds to the specific Memo-ID or ETH address.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
| targetAsset | path | string | true | none |
| network | query | string | false | none |
Enumerated Values
| Parameter | Value |
|---|---|
| targetAsset | USD |
| targetAsset | BTC |
| targetAsset | ETH |
| targetAsset | PAX |
| targetAsset | PAXG |
| targetAsset | UNALLOCATED_GOLD |
| targetAsset | ALLOCATED_GOLD |
| targetAsset | BUSD |
| targetAsset | HUSD |
| targetAsset | EUR |
| targetAsset | SGD |
| targetAsset | BCH |
| targetAsset | LTC |
| targetAsset | USDP |
| targetAsset | AAVE |
| targetAsset | UNI |
| targetAsset | MATIC |
| targetAsset | PYUSD |
| targetAsset | LINK |
| targetAsset | SOL |
| network | NETWORK_BTC |
| network | NETWORK_ETH |
| network | NETWORK_BCH |
| network | NETWORK_LTC |
| network | NETWORK_SOL |
Example responses
200 Response
{
"type": "object",
"properties": {
"ethNetwork": {
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
},
"wire": {
"type": "object",
"properties": {
"depositMemo": {
"type": "object",
"properties": {
"memo": {
"type": "string"
},
"destinationAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
}
}
},
"bank": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"country": {
"type": "string"
},
"address": {
"type": "string"
},
"routingNumber": {
"type": "string"
},
"recipientName": {
"type": "string"
},
"recipientAddress": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"swiftIntermediaryBankName": {
"type": "string"
},
"swiftIntermediaryBankAddress": {
"type": "string"
},
"swiftCode": {
"type": "string"
}
}
}
},
"required": [
"depositMemo",
"bank"
]
},
"aba": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"routingNumber": {
"type": "string",
"description": "The Paxos routing number."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress",
"bankAddress"
]
},
"swift": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the Paxos bank."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank or intermediary."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"senName": {
"type": "string",
"description": "The Paxos SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
}
},
"description": "The SEN transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The SIGNET transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The CBIT transfer instructions for depositing to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number/identifier."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"type"
]
},
"solNetwork": {
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | GetCryptoAddressAutoConversionInstructionsResponse |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CreateCryptoWithdrawal
POST /v1/crypto-withdrawals
Request a withdrawal from a balance at Paxos to an external crypto address.
Body parameter
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"cryptoAddressId": {
"type": "string",
"title": "external id of customer crypto address"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"title": "If the same external_id is supplied in multiple requests, only one will go through (idempotence)"
},
"beneficiary": {
"type": "object",
"properties": {
"personDetails": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
},
"required": [
"firstName",
"lastName"
]
},
"institutionDetails": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
}
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
}
},
"title": "Withdraw request for crypto",
"required": [
"profileId",
"cryptoAddressId",
"assetType",
"amount",
"externalId"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateCryptoWithdrawalRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CreateCryptoWithdrawalResponse |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 404 | Not Found | Not Found | Inline |
| 409 | Conflict | Already Exists | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
ListProfiles
GET /v1/profiles
Returns a list of profiles for the authenticated customer.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filters.id | query | string | false | none |
| filters.kycId | query | string | false | kycid |
Example responses
200 Response
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | ListProfilesResponse |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
GetProfile
GET /v1/profiles/{id}
Returns a profile within the customer's Paxos account, specified by id.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | profile id |
Example responses
200 Response
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | Profile |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
ArchiveProfile
DELETE /v1/profiles/{id}
Deactivates a given profile by id.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
200 Response
{
"type": "object"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | ArchiveProfileResponse |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
GetProfileBalances
GET /v1/profiles/{id}/balances
Read customer balances for a specific profile id is one of [uuid, "summary", "default"]
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
| assetTypes | query | array[string] | false | none |
Enumerated Values
| Parameter | Value |
|---|---|
| assetTypes | USD |
| assetTypes | BTC |
| assetTypes | ETH |
| assetTypes | PAX |
| assetTypes | PAXG |
| assetTypes | UNALLOCATED_GOLD |
| assetTypes | ALLOCATED_GOLD |
| assetTypes | BUSD |
| assetTypes | HUSD |
| assetTypes | EUR |
| assetTypes | SGD |
| assetTypes | BCH |
| assetTypes | LTC |
| assetTypes | USDP |
| assetTypes | AAVE |
| assetTypes | UNI |
| assetTypes | MATIC |
| assetTypes | PYUSD |
| assetTypes | LINK |
| assetTypes | SOL |
Example responses
200 Response
{
"type": "object",
"properties": {
"balances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"available": {
"type": "string"
},
"pendingCredit": {
"type": "string"
},
"pendingDebit": {
"type": "string"
},
"pendingTotal": {
"type": "string"
},
"trading": {
"type": "string"
}
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | GetProfileBalancesResponse |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
GetProfileDepositInstructions
GET /v1/profiles/{id}/instructions
Returns wire deposit instructions for the given profile.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | profile id |
Example responses
200 Response
{
"type": "object",
"properties": {
"profileId": {
"type": "string"
},
"transferInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"realm": {
"type": "string",
"enum": [
"FIAT",
"CRYPTO"
],
"description": "Realm (FIAT or CRYPTO).\n\n - FIAT: The traditional fiat banking world.\n - CRYPTO: The cryptocurrency world."
},
"cryptoNetwork": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"autoConversion": {
"type": "boolean",
"description": "True if this transfer will trigger PAX auto-conversion."
},
"sendToBank": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"aba": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"routingNumber": {
"type": "string",
"description": "The Paxos routing number."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress",
"bankAddress"
]
},
"swift": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the Paxos bank."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank or intermediary."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"senName": {
"type": "string",
"description": "The Paxos SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
}
},
"description": "The SEN transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The SIGNET transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The CBIT transfer instructions for depositing to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number/identifier."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "PaxosBankAccount is a bank account owned by Paxos and used by customers for\ndepositing fiat. Read-only."
},
"sendToAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "PaxosCryptoAddress is a crypto address owned by Paxos and used by customers\nfor depositing crypto."
}
}
}
}
},
"title": "Deposit instructions for a specific profile"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | ProfileDepositInstructions |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CreateSenWithdrawal
POST /v1/sen-withdrawals
Request a withdrawal from a balance at Paxos through SEN.
Body parameter
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"bankAccountId": {
"type": "string",
"title": "customer bank account"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"description": "If the same `external_id` is supplied in multiple requests, only the first one will go through (idempotence)."
}
},
"required": [
"profileId",
"bankAccountId",
"amount",
"externalId"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateSenWithdrawalRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CreateSenWithdrawalResponse |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 404 | Not Found | Not Found | Inline |
| 409 | Conflict | Already Exists | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CreateSignetWithdrawal
POST /v1/signet-withdrawals
Request a withdrawal from a balance at Paxos through SIGNET.
Body parameter
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"bankAccountId": {
"type": "string",
"title": "customer bank account"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"description": "If the same `external_id` is supplied in multiple requests, only the first one will go through (idempotence)."
}
},
"required": [
"profileId",
"bankAccountId",
"amount",
"externalId"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateSignetWithdrawalRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CreateSignetWithdrawalResponse |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 404 | Not Found | Not Found | Inline |
| 409 | Conflict | Already Exists | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CreatePeerTransfer
POST /v1/transfers/peer
Request a transfer to a peer's profile (another customer on the Paxos Platform) from the customer's provided profile ID
Body parameter
{
"type": "object",
"properties": {
"fromProfileId": {
"type": "string"
},
"toTransferId": {
"type": "string"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"amount": {
"type": "string",
"pattern": "^[0-9]*\\.?[0-9]+$"
},
"externalId": {
"type": "string"
}
},
"required": [
"fromProfileId",
"toTransferId",
"assetType",
"amount",
"externalId"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreatePeerTransferRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"sendTransfer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CreatePeerTransferResponse |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 404 | Not Found | Not Found | Inline |
| 409 | Conflict | Already Exists | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CreateProfileTransfer
POST /v1/transfers/profile
Request a transfer from one profile to another for the same customer
Body parameter
{
"type": "object",
"properties": {
"fromProfileId": {
"type": "string"
},
"toProfileId": {
"type": "string"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"amount": {
"type": "string",
"pattern": "^[0-9]*\\.?[0-9]+$"
},
"externalId": {
"type": "string"
}
},
"title": "Internal transfer request",
"required": [
"fromProfileId",
"toProfileId",
"assetType",
"amount",
"externalId"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateProfileTransferRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"sendTransfer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
},
"recvTransfer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
},
"title": "Returns both of the newly created activities"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CreateProfileTransferResponse |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 404 | Not Found | Not Found | Inline |
| 409 | Conflict | Already Exists | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CreateWireWithdrawal
POST /v1/wire-withdrawals
Request a withdrawal from a balance at Paxos through ABA or SWIFT.
Body parameter
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"bankAccountId": {
"type": "string",
"title": "customer bank account"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"description": "If the same `external_id` is supplied in multiple requests, only the first one will go through (idempotence)."
}
},
"title": "Withdraw request for ABA and SWIFT",
"required": [
"profileId",
"bankAccountId",
"amount",
"externalId"
]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateWireWithdrawalRequest | true | none |
Example responses
200 Response
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | CreateWireWithdrawalResponse |
| 400 | Bad Request | Invalid Argument | Inline |
| 401 | Unauthorized | Unauthenticated | Inline |
| 403 | Forbidden | Permission Denied | Inline |
| 404 | Not Found | Not Found | Inline |
| 409 | Conflict | Already Exists | Inline |
| 500 | Internal Server Error | Internal | Inline |
Response Schema
CustomerPublic
GetCustStatus
GET /v1/customer/status
Returns information on how far the customer's onboarding has progressed at Paxos.
Example responses
200 Response
{
"type": "object",
"properties": {
"custStatus": {
"type": "object",
"properties": {
"kycStatus": {
"type": "string",
"enum": [
"KYC_STATUS_NOT_STARTED",
"KYC_STATUS_IN_PROGRESS",
"KYC_STATUS_PROCESSING",
"KYC_STATUS_FAILED_JUMIO",
"KYC_STATUS_FAILED_COMPLYADVANTAGE",
"KYC_STATUS_DENIED",
"KYC_STATUS_PENDING",
"KYC_STATUS_PENDING_INSTITUTION",
"KYC_STATUS_APPROVED",
"KYC_STATUS_SET_FOR_CLOSURE"
],
"description": "TODO: Admins need more visibility into KYC status."
},
"accountStatus": {
"type": "string",
"enum": [
"APPROVED",
"DISABLED",
"KYC_NOT_SUBMITTED",
"KYC_IN_PROGRESS"
]
},
"institutionality": {
"type": "string",
"enum": [
"INDIVIDUAL",
"INSTITUTION"
]
}
}
},
"customerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"institutionName": {
"type": "string"
},
"officialName": {
"type": "string"
},
"address": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"city": {
"type": "string"
},
"province": {
"type": "string"
},
"zipCode": {
"type": "string"
}
}
}
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response. | GetCustStatusResponse |
Schemas
GetActivitiesRequestOrderingPolicy
{
"type": "string",
"enum": [
"CREATED_AT_DESC",
"CREATED_AT_ASC"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | CREATED_AT_DESC |
| anonymous | CREATED_AT_ASC |
SWIFTWithdrawalInstructionsIntermediary
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
An intermediary bank for SWIFT withdrawals.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | The name of the intermediary bank. |
| swiftBic | string | true | none | The SWIFT Bank Identifier Code (BIC) of the intermediary bank. |
| address | string | false | none | none |
ABADepositInstructions
{
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"routingNumber": {
"type": "string",
"description": "The Paxos routing number."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress",
"bankAddress"
]
}
The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| memoId | string | true | none | A unique personal code for routing the deposited funds at Paxos. The customer should put this string in the transfer memo field, for any type of transfer. |
| beneficiaryName | string | true | none | The Paxos entity name. |
| accountNumber | string | true | none | The Paxos account number. |
| routingNumber | string | true | none | The Paxos routing number. |
| bankName | string | true | none | The name of the Paxos bank. |
| beneficiaryAddress | MailingAddress | true | none | A mailing address. |
| bankAddress | MailingAddress | true | none | A mailing address. |
ABAWithdrawalInstructions
{
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
}
Instructions for an ABA wire withdrawal.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| beneficiaryName | string | true | none | The name of the customer to credit. |
| accountNumber | string | true | none | The account number. |
| routingNumber | string | true | none | The routing number. |
| bankName | string | true | none | The name of the bank. |
| beneficiaryAddress | MailingAddress | true | none | A mailing address. |
| forFurtherCredit | string | false | none | Additional account ID. Optional. |
Activity
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | none | The UUID of the activity. |
| createdAt | string(date-time) | true | none | none |
| updatedAt | string(date-time) | true | none | none |
| assetType | AssetType | true | none | none |
| principal | string | true | none | none |
| fee | string | true | none | none |
| status | ActivityStatus | true | none | none |
| activityClass | ActivityClass | true | none | High level class of activity. |
| activityType | ActivityType | true | none | Type of activity. |
| externalId | string | false | none | none |
| txId | string | false | none | none |
| fromProfile | Profile | false | none | none |
| fromBankAccount | OriginBankAccount | false | none | none |
| fromAddress | OriginCryptoAddress | false | none | none |
| toProfile | Profile | false | none | none |
| toBankAccount | CustomerBankAccount | false | none | A customer-saved bank account used for withdrawals. |
| toAddress | CustomerCryptoAddress | false | none | A customer saved crypto address for withdrawals. |
| refundedByActivityId | string | false | none | none |
| refundForActivityId | string | false | none | none |
| secondaryStatus | SecondaryStatus | false | none | Secondary status for the transfer, used for more granular explanation of the transfer status. |
ActivityClass
{
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
}
High level class of activity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | High level class of activity. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | DEPOSIT |
| anonymous | WITHDRAWAL |
| anonymous | TRANSFER |
ActivityFilter
{
"type": "object",
"properties": {
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"txId": {
"type": "string",
"title": "Raw txHash"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| activityType | ActivityType | false | none | Type of activity. |
| txId | string | false | none | none |
ActivityStatus
{
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
}
Activity status
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| Activity status | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| Activity status | COMPLETE |
| Activity status | PENDING |
| Activity status | ERRORED |
| Activity status | CANCELLED |
ActivityType
{
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
}
Type of activity.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Type of activity. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | SEND_PROFILE_TRANSFER |
| anonymous | RECV_PROFILE_TRANSFER |
| anonymous | CRYPTO_DEPOSIT |
| anonymous | CRYPTO_WITHDRAWAL |
| anonymous | WIRE_DEPOSIT |
| anonymous | WIRE_WITHDRAWAL |
| anonymous | SEN_DEPOSIT |
| anonymous | SEN_WITHDRAWAL |
| anonymous | PAXOS_CREDIT |
| anonymous | PAXOS_DEBIT |
| anonymous | BANK_DEPOSIT |
| anonymous | BANK_WITHDRAWAL |
| anonymous | UNALLOCATED_GOLD_DEPOSIT |
| anonymous | UNALLOCATED_GOLD_WITHDRAWAL |
| anonymous | ALLOCATED_GOLD_WITHDRAWAL |
| anonymous | TOKEN_ORDER |
| anonymous | TO_ITBIT_TRANSFER |
| anonymous | FROM_ITBIT_TRANSFER |
| anonymous | SEND_PEER_TRANSFER |
| anonymous | RECV_PEER_TRANSFER |
| anonymous | ADMIN_SEND_PEER_TRANSFER |
| anonymous | ADMIN_RECV_PEER_TRANSFER |
| anonymous | SIGNET_DEPOSIT |
| anonymous | SIGNET_WITHDRAWAL |
| anonymous | CBIT_WITHDRAWAL |
| anonymous | CBIT_DEPOSIT |
ArchiveBankAccountResponse
{
"type": "object"
}
Properties
None
ArchiveProfileResponse
{
"type": "object"
}
Properties
None
AssetType
{
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
}
AssetType
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| AssetType | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| AssetType | USD |
| AssetType | BTC |
| AssetType | ETH |
| AssetType | PAX |
| AssetType | PAXG |
| AssetType | UNALLOCATED_GOLD |
| AssetType | ALLOCATED_GOLD |
| AssetType | BUSD |
| AssetType | HUSD |
| AssetType | EUR |
| AssetType | SGD |
| AssetType | BCH |
| AssetType | LTC |
| AssetType | USDP |
| AssetType | AAVE |
| AssetType | UNI |
| AssetType | MATIC |
| AssetType | PYUSD |
| AssetType | LINK |
| AssetType | SOL |
AutoConversion
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"profileId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"depositAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"withdrawalAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"deposit": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
},
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
},
"withdrawalDestAddressId": {
"type": "string"
},
"withdrawalDestBankAccountId": {
"type": "string"
},
"amount": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"PENDING_DEPOSIT",
"ERROR_DEPOSIT",
"PENDING_WITHDRAWAL",
"ERROR_WITHDRAWAL",
"COMPLETE"
]
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| profileId | string | false | none | none |
| createdAt | string(date-time) | false | none | none |
| updatedAt | string(date-time) | false | none | none |
| depositAssetType | AssetType | false | none | none |
| withdrawalAssetType | AssetType | false | none | none |
| deposit | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
| withdrawal | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
| withdrawalDestAddressId | string | false | none | none |
| withdrawalDestBankAccountId | string | false | none | none |
| amount | string | false | none | none |
| status | AutoConversionStatus | false | none | none |
AutoConversionStatus
{
"type": "string",
"enum": [
"PENDING_DEPOSIT",
"ERROR_DEPOSIT",
"PENDING_WITHDRAWAL",
"ERROR_WITHDRAWAL",
"COMPLETE"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | PENDING_DEPOSIT |
| anonymous | ERROR_DEPOSIT |
| anonymous | PENDING_WITHDRAWAL |
| anonymous | ERROR_WITHDRAWAL |
| anonymous | COMPLETE |
Balance
{
"type": "object",
"properties": {
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"available": {
"type": "string"
},
"pendingCredit": {
"type": "string"
},
"pendingDebit": {
"type": "string"
},
"pendingTotal": {
"type": "string"
},
"trading": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| assetType | AssetType | false | none | none |
| available | string | false | none | none |
| pendingCredit | string | false | none | none |
| pendingDebit | string | false | none | none |
| pendingTotal | string | false | none | none |
| trading | string | false | none | none |
BankInformation
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"country": {
"type": "string"
},
"address": {
"type": "string"
},
"routingNumber": {
"type": "string"
},
"recipientName": {
"type": "string"
},
"recipientAddress": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"swiftIntermediaryBankName": {
"type": "string"
},
"swiftIntermediaryBankAddress": {
"type": "string"
},
"swiftCode": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | false | none | none |
| country | string | false | none | none |
| address | string | false | none | none |
| routingNumber | string | false | none | none |
| recipientName | string | false | none | none |
| recipientAddress | string | false | none | none |
| accountNumber | string | false | none | none |
| swiftIntermediaryBankName | string | false | none | none |
| swiftIntermediaryBankAddress | string | false | none | none |
| swiftCode | string | false | none | none |
Beneficiary
{
"type": "object",
"properties": {
"personDetails": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
},
"required": [
"firstName",
"lastName"
]
},
"institutionDetails": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| personDetails | BeneficiaryPerson | false | none | none |
| institutionDetails | BeneficiaryInstitution | false | none | none |
BeneficiaryInstitution
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
BeneficiaryPerson
{
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
},
"required": [
"firstName",
"lastName"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| firstName | string | true | none | none |
| lastName | string | true | none | none |
CBITDepositInstructions
{
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The CBIT transfer instructions for depositing to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
}
The CBIT transfer instructions for depositing to Paxos. Read-only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| memoId | string | true | none | A unique personal code for routing the deposited funds at Paxos. The customer should use memo_id in the transfer-memo field for all transfer types. |
| beneficiaryName | string | true | none | The Paxos entity name. |
| walletAddress | string | true | none | The Paxos wallet address. |
CBITWithdrawalInstructions
{
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
}
Instructions for a Customers Bank Network (CBIT) withdrawal.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| beneficiaryName | string | true | none | The withdrawal beneficiary. |
| walletAddress | string | true | none | The wallet address. |
CreateBankAccountRequest
{
"type": "object",
"properties": {
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "Save a bank account. Specify exactly one instruction type. For example, \"cbit\".",
"required": [
"nickname"
]
}
Save a bank account. Specify exactly one instruction type. For example, "cbit".
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| nickname | string | true | none | The display name of this saved bank account. Must be unique. |
| aba | ABAWithdrawalInstructions | false | none | Instructions for an ABA wire withdrawal. |
| swift | SWIFTWithdrawalInstructions | false | none | Instructions for a SWIFT wire withdrawal. |
| sen | SENWithdrawalInstructions | false | none | Instructions for a Silvergate Exchange Network (SEN) withdrawal. |
| signet | SIGNETWithdrawalInstructions | false | none | Instructions for a SIGNATURE Network (SIGNET) withdrawal. |
| cbit | CBITWithdrawalInstructions | false | none | Instructions for a Customers Bank Network (CBIT) withdrawal. |
| intrabank | IntrabankWithdrawalInstructions | false | none | Instructions for a generic intra-bank network withdrawal. For example, CBIT. |
CreateCbitWithdrawalRequest
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"bankAccountId": {
"type": "string",
"title": "customer bank account"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"description": "If the same `external_id` is supplied in multiple requests, only the first one will go through (idempotence)."
}
},
"required": [
"profileId",
"bankAccountId",
"amount",
"externalId"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| profileId | string | true | none | none |
| bankAccountId | string | true | none | none |
| amount | string | true | none | none |
| externalId | string | true | none | If the same external_id is supplied in multiple requests, only the first one will go through (idempotence). |
CreateCbitWithdrawalResponse
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| withdrawal | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
CreateCryptoWithdrawalRequest
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"cryptoAddressId": {
"type": "string",
"title": "external id of customer crypto address"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"title": "If the same external_id is supplied in multiple requests, only one will go through (idempotence)"
},
"beneficiary": {
"type": "object",
"properties": {
"personDetails": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
},
"required": [
"firstName",
"lastName"
]
},
"institutionDetails": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
}
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
}
},
"title": "Withdraw request for crypto",
"required": [
"profileId",
"cryptoAddressId",
"assetType",
"amount",
"externalId"
]
}
Withdraw request for crypto
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| profileId | string | true | none | none |
| cryptoAddressId | string | true | none | none |
| assetType | AssetType | true | none | none |
| amount | string | true | none | none |
| externalId | string | true | none | none |
| beneficiary | Beneficiary | false | none | none |
| network | Network | false | none | Crypto network. |
CreateCryptoWithdrawalResponse
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| withdrawal | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
CreateIntrabankWithdrawalResponse
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
},
"description": "Do not use."
}
Do not use.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| withdrawal | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
CreatePeerTransferRequest
{
"type": "object",
"properties": {
"fromProfileId": {
"type": "string"
},
"toTransferId": {
"type": "string"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"amount": {
"type": "string",
"pattern": "^[0-9]*\\.?[0-9]+$"
},
"externalId": {
"type": "string"
}
},
"required": [
"fromProfileId",
"toTransferId",
"assetType",
"amount",
"externalId"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fromProfileId | string | true | none | none |
| toTransferId | string | true | none | none |
| assetType | AssetType | true | none | none |
| amount | string | true | none | none |
| externalId | string | true | none | none |
CreatePeerTransferResponse
{
"type": "object",
"properties": {
"sendTransfer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| sendTransfer | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
CreateProfileTransferRequest
{
"type": "object",
"properties": {
"fromProfileId": {
"type": "string"
},
"toProfileId": {
"type": "string"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"amount": {
"type": "string",
"pattern": "^[0-9]*\\.?[0-9]+$"
},
"externalId": {
"type": "string"
}
},
"title": "Internal transfer request",
"required": [
"fromProfileId",
"toProfileId",
"assetType",
"amount",
"externalId"
]
}
Internal transfer request
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fromProfileId | string | true | none | none |
| toProfileId | string | true | none | none |
| assetType | AssetType | true | none | none |
| amount | string | true | none | none |
| externalId | string | true | none | none |
CreateProfileTransferResponse
{
"type": "object",
"properties": {
"sendTransfer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
},
"recvTransfer": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
},
"title": "Returns both of the newly created activities"
}
Returns both of the newly created activities
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| sendTransfer | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
| recvTransfer | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
CreateSenWithdrawalRequest
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"bankAccountId": {
"type": "string",
"title": "customer bank account"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"description": "If the same `external_id` is supplied in multiple requests, only the first one will go through (idempotence)."
}
},
"required": [
"profileId",
"bankAccountId",
"amount",
"externalId"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| profileId | string | true | none | none |
| bankAccountId | string | true | none | none |
| amount | string | true | none | none |
| externalId | string | true | none | If the same external_id is supplied in multiple requests, only the first one will go through (idempotence). |
CreateSenWithdrawalResponse
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| withdrawal | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
CreateSignetWithdrawalRequest
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"bankAccountId": {
"type": "string",
"title": "customer bank account"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"description": "If the same `external_id` is supplied in multiple requests, only the first one will go through (idempotence)."
}
},
"required": [
"profileId",
"bankAccountId",
"amount",
"externalId"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| profileId | string | true | none | none |
| bankAccountId | string | true | none | none |
| amount | string | true | none | none |
| externalId | string | true | none | If the same external_id is supplied in multiple requests, only the first one will go through (idempotence). |
CreateSignetWithdrawalResponse
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| withdrawal | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
CreateWireWithdrawalRequest
{
"type": "object",
"properties": {
"profileId": {
"type": "string",
"title": "uuid for profile"
},
"bankAccountId": {
"type": "string",
"title": "customer bank account"
},
"amount": {
"type": "string"
},
"externalId": {
"type": "string",
"description": "If the same `external_id` is supplied in multiple requests, only the first one will go through (idempotence)."
}
},
"title": "Withdraw request for ABA and SWIFT",
"required": [
"profileId",
"bankAccountId",
"amount",
"externalId"
]
}
Withdraw request for ABA and SWIFT
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| profileId | string | true | none | none |
| bankAccountId | string | true | none | none |
| amount | string | true | none | none |
| externalId | string | true | none | If the same external_id is supplied in multiple requests, only the first one will go through (idempotence). |
CreateWireWithdrawalResponse
{
"type": "object",
"properties": {
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| withdrawal | Activity | false | none | A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only. |
CustomerBankAccount
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
}
A customer-saved bank account used for withdrawals.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | none | none |
| revision | string(uint64) | true | none | none |
| nickname | string | true | none | The display name of this saved bank account. Must be unique. |
| type | CustomerBankAccountType | true | none | The bank account type: The kind of transfer Paxos will perform for a withdrawal. - ABA: A U.S. domestic wire destination. - SWIFT: An international wire destination. - SEN: A destination on the "Silvergate Exchange Network" (between Silvergate accounts). - ACH: ACH - SIGNET: A destination on the Signet Platform (between Signature accounts). - CBIT: A destination on the CBIT Network (between Customers Bank accounts). |
| aba | ABAWithdrawalInstructions | false | none | Instructions for an ABA wire withdrawal. |
| swift | SWIFTWithdrawalInstructions | false | none | Instructions for a SWIFT wire withdrawal. |
| sen | SENWithdrawalInstructions | false | none | Instructions for a Silvergate Exchange Network (SEN) withdrawal. |
| signet | SIGNETWithdrawalInstructions | false | none | Instructions for a SIGNATURE Network (SIGNET) withdrawal. |
| cbit | CBITWithdrawalInstructions | false | none | Instructions for a Customers Bank Network (CBIT) withdrawal. |
| intrabank | IntrabankWithdrawalInstructions | false | none | Instructions for a generic intra-bank network withdrawal. For example, CBIT. |
CustomerBankAccountType
{
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
The bank account type: The kind of transfer Paxos will perform for a withdrawal.
- ABA: A U.S. domestic wire destination.
- SWIFT: An international wire destination.
- SEN: A destination on the "Silvergate Exchange Network" (between Silvergate accounts).
- ACH: ACH
- SIGNET: A destination on the Signet Platform (between Signature accounts).
- CBIT: A destination on the CBIT Network (between Customers Bank accounts).
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | The bank account type: The kind of transfer Paxos will perform for a withdrawal. - ABA: A U.S. domestic wire destination. - SWIFT: An international wire destination. - SEN: A destination on the "Silvergate Exchange Network" (between Silvergate accounts). - ACH: ACH - SIGNET: A destination on the Signet Platform (between Signature accounts). - CBIT: A destination on the CBIT Network (between Customers Bank accounts). |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | ABA |
| anonymous | SWIFT |
| anonymous | SEN |
| anonymous | ACH |
| anonymous | SIGNET |
| anonymous | CBIT |
CustomerCryptoAddress
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
}
A customer saved crypto address for withdrawals.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| revision | string(uint64) | false | none | none |
| nickname | string | false | none | none |
| network | Network | false | none | Crypto network. |
| address | string | false | none | none |
DepositMemo
{
"type": "object",
"properties": {
"memo": {
"type": "string"
},
"destinationAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| memo | string | false | none | none |
| destinationAssetType | AssetType | false | none | none |
ETHDepositInstructions
{
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| depositAddress | string | false | none | none |
Filters
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"kycId": {
"type": "string",
"title": "kycid"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| kycId | string | false | none | none |
GetActivitiesResponse
{
"type": "object",
"properties": {
"activities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
}
},
"count": {
"type": "integer",
"format": "int32"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| activities | [Activity] | false | none | [A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.] |
| count | integer(int32) | false | none | none |
GetBankAccountAutoConversionInstructionsResponse
{
"type": "object",
"properties": {
"eth": {
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
},
"sol": {
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| eth | ETHDepositInstructions | false | none | none |
| sol | SOLDepositInstructions | false | none | none |
GetCryptoAddressAutoConversionInstructionsResponse
{
"type": "object",
"properties": {
"ethNetwork": {
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
},
"wire": {
"type": "object",
"properties": {
"depositMemo": {
"type": "object",
"properties": {
"memo": {
"type": "string"
},
"destinationAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
}
}
},
"bank": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"country": {
"type": "string"
},
"address": {
"type": "string"
},
"routingNumber": {
"type": "string"
},
"recipientName": {
"type": "string"
},
"recipientAddress": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"swiftIntermediaryBankName": {
"type": "string"
},
"swiftIntermediaryBankAddress": {
"type": "string"
},
"swiftCode": {
"type": "string"
}
}
}
},
"required": [
"depositMemo",
"bank"
]
},
"aba": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"routingNumber": {
"type": "string",
"description": "The Paxos routing number."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress",
"bankAddress"
]
},
"swift": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the Paxos bank."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank or intermediary."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"senName": {
"type": "string",
"description": "The Paxos SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
}
},
"description": "The SEN transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The SIGNET transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The CBIT transfer instructions for depositing to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number/identifier."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"type"
]
},
"solNetwork": {
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ethNetwork | ETHDepositInstructions | false | none | none |
| wire | WireDepositInstructions | false | none | none |
| aba | ABADepositInstructions | false | none | The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only. |
| swift | SWIFTDepositInstructions | false | none | The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only. |
| sen | SENDepositInstructions | false | none | The SEN transfer instructions for depositing fiat to Paxos. Read-only. |
| signet | SIGNETDepositInstructions | false | none | The SIGNET transfer instructions for depositing fiat to Paxos. Read-only. |
| cbit | CBITDepositInstructions | false | none | The CBIT transfer instructions for depositing to Paxos. Read-only. |
| intrabank | IntrabankDepositInstructions | false | none | The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only. |
| solNetwork | SOLDepositInstructions | false | none | none |
GetProfileBalancesResponse
{
"type": "object",
"properties": {
"balances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"available": {
"type": "string"
},
"pendingCredit": {
"type": "string"
},
"pendingDebit": {
"type": "string"
},
"pendingTotal": {
"type": "string"
},
"trading": {
"type": "string"
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| balances | [Balance] | false | none | none |
IntrabankDepositInstructions
{
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number/identifier."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"type"
]
}
The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| memoId | string | true | none | A unique personal code for routing the deposited funds at Paxos. The customer should use memo_id in the transfer-memo field for all transfer types. |
| beneficiaryName | string | true | none | The Paxos entity name. |
| accountNumber | string | true | none | The Paxos account number/identifier. |
| type | CustomerBankAccountType | true | none | The bank account type: The kind of transfer Paxos will perform for a withdrawal. - ABA: A U.S. domestic wire destination. - SWIFT: An international wire destination. - SEN: A destination on the "Silvergate Exchange Network" (between Silvergate accounts). - ACH: ACH - SIGNET: A destination on the Signet Platform (between Signature accounts). - CBIT: A destination on the CBIT Network (between Customers Bank accounts). |
IntrabankWithdrawalInstructions
{
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
Instructions for a generic intra-bank network withdrawal. For example, CBIT.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| beneficiaryName | string | true | none | The withdrawal beneficiary. |
| accountNumber | string | true | none | The account number. |
| type | CustomerBankAccountType | true | none | The bank account type: The kind of transfer Paxos will perform for a withdrawal. - ABA: A U.S. domestic wire destination. - SWIFT: An international wire destination. - SEN: A destination on the "Silvergate Exchange Network" (between Silvergate accounts). - ACH: ACH - SIGNET: A destination on the Signet Platform (between Signature accounts). - CBIT: A destination on the CBIT Network (between Customers Bank accounts). |
ListAutoConversionsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"profileId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"depositAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"withdrawalAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"deposit": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
},
"withdrawal": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UUID of the activity."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"assetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
},
"principal": {
"type": "string"
},
"fee": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"COMPLETE",
"PENDING",
"ERRORED",
"CANCELLED"
],
"title": "Activity status"
},
"activityClass": {
"type": "string",
"enum": [
"DEPOSIT",
"WITHDRAWAL",
"TRANSFER"
],
"description": "High level class of activity."
},
"activityType": {
"type": "string",
"enum": [
"SEND_PROFILE_TRANSFER",
"RECV_PROFILE_TRANSFER",
"CRYPTO_DEPOSIT",
"CRYPTO_WITHDRAWAL",
"WIRE_DEPOSIT",
"WIRE_WITHDRAWAL",
"SEN_DEPOSIT",
"SEN_WITHDRAWAL",
"PAXOS_CREDIT",
"PAXOS_DEBIT",
"BANK_DEPOSIT",
"BANK_WITHDRAWAL",
"UNALLOCATED_GOLD_DEPOSIT",
"UNALLOCATED_GOLD_WITHDRAWAL",
"ALLOCATED_GOLD_WITHDRAWAL",
"TOKEN_ORDER",
"TO_ITBIT_TRANSFER",
"FROM_ITBIT_TRANSFER",
"SEND_PEER_TRANSFER",
"RECV_PEER_TRANSFER",
"ADMIN_SEND_PEER_TRANSFER",
"ADMIN_RECV_PEER_TRANSFER",
"SIGNET_DEPOSIT",
"SIGNET_WITHDRAWAL",
"CBIT_WITHDRAWAL",
"CBIT_DEPOSIT"
],
"description": "Type of activity."
},
"externalId": {
"type": "string"
},
"txId": {
"type": "string"
},
"fromProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"fromBankAccount": {
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
},
"fromAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
},
"toProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
},
"toBankAccount": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
},
"toAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
},
"refundedByActivityId": {
"type": "string"
},
"refundForActivityId": {
"type": "string"
},
"secondaryStatus": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
},
"description": "A customer transaction (fiat deposit, crypto deposit, fiat withdrawal, crypto withdrawal, internal transfer, etc). Read-only.",
"required": [
"id",
"createdAt",
"updatedAt",
"assetType",
"principal",
"fee",
"status",
"activityClass",
"activityType"
]
},
"withdrawalDestAddressId": {
"type": "string"
},
"withdrawalDestBankAccountId": {
"type": "string"
},
"amount": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"PENDING_DEPOSIT",
"ERROR_DEPOSIT",
"PENDING_WITHDRAWAL",
"ERROR_WITHDRAWAL",
"COMPLETE"
]
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [AutoConversion] | false | none | none |
ListBankAccountsResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string",
"description": "The display name of this saved bank account. Must be unique."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
},
"aba": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"routingNumber": {
"type": "string",
"description": "The routing number.",
"maxLength": 9,
"minLength": 9,
"pattern": "^[0-9]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
}
},
"description": "Instructions for an ABA wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress"
]
},
"swift": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a Customers Bank Network (CBIT) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"accountNumber": {
"type": "string",
"description": "The account number."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "Instructions for a generic intra-bank network withdrawal. For example, CBIT.",
"required": [
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "A customer-saved bank account used for withdrawals.",
"required": [
"id",
"revision",
"nickname",
"type"
]
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [CustomerBankAccount] | false | none | [A customer-saved bank account used for withdrawals.] |
ListCryptoAddressesResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "string",
"format": "uint64"
},
"nickname": {
"type": "string"
},
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "A customer saved crypto address for withdrawals."
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [CustomerCryptoAddress] | false | none | [A customer saved crypto address for withdrawals.] |
ListProfilesResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| data | [Profile] | false | none | none |
MailingAddress
{
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
A mailing address.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string | true | none | none |
| address1 | string | false | none | none |
| address2 | string | false | none | none |
| city | string | false | none | none |
| province | string | false | none | none |
| zipCode | string | false | none | none |
Network
{
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
}
Crypto network.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Crypto network. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | NETWORK_BTC |
| anonymous | NETWORK_ETH |
| anonymous | NETWORK_BCH |
| anonymous | NETWORK_LTC |
| anonymous | NETWORK_SOL |
OriginBankAccount
{
"type": "object",
"properties": {
"bankName": {
"type": "string"
},
"accountNumber": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| bankName | string | false | none | none |
| accountNumber | string | false | none | none |
OriginCryptoAddress
{
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| network | Network | false | none | Crypto network. |
| address | string | false | none | none |
Pagination
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"format": "int32",
"title": "Number of results to return"
},
"offset": {
"type": "integer",
"format": "int32",
"title": "Number of results to skip"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| limit | integer(int32) | false | none | none |
| offset | integer(int32) | false | none | none |
PaxosBankAccount
{
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"aba": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"routingNumber": {
"type": "string",
"description": "The Paxos routing number."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress",
"bankAddress"
]
},
"swift": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the Paxos bank."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank or intermediary."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"senName": {
"type": "string",
"description": "The Paxos SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
}
},
"description": "The SEN transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The SIGNET transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The CBIT transfer instructions for depositing to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number/identifier."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "PaxosBankAccount is a bank account owned by Paxos and used by customers for\ndepositing fiat. Read-only."
}
PaxosBankAccount is a bank account owned by Paxos and used by customers for depositing fiat. Read-only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| memoId | string | false | none | A unique personal code for routing the deposited funds at Paxos. The customer should put this string in the transfer memo field, for any type of transfer. |
| aba | ABADepositInstructions | false | none | The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only. |
| swift | SWIFTDepositInstructions | false | none | The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only. |
| sen | SENDepositInstructions | false | none | The SEN transfer instructions for depositing fiat to Paxos. Read-only. |
| signet | SIGNETDepositInstructions | false | none | The SIGNET transfer instructions for depositing fiat to Paxos. Read-only. |
| cbit | CBITDepositInstructions | false | none | The CBIT transfer instructions for depositing to Paxos. Read-only. |
| intrabank | IntrabankDepositInstructions | false | none | The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only. |
PaxosCryptoAddress
{
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "PaxosCryptoAddress is a crypto address owned by Paxos and used by customers\nfor depositing crypto."
}
PaxosCryptoAddress is a crypto address owned by Paxos and used by customers for depositing crypto.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| network | Network | false | none | Crypto network. |
| address | string | false | none | none |
Profile
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"nickname": {
"type": "string"
},
"description": {
"type": "string"
},
"profileType": {
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
},
"kycId": {
"type": "string"
},
"transferId": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | false | none | none |
| nickname | string | false | none | none |
| description | string | false | none | none |
| profileType | ProfileType | false | none | none |
| kycId | string | false | none | none |
| transferId | string | false | none | none |
ProfileDepositInstructions
{
"type": "object",
"properties": {
"profileId": {
"type": "string"
},
"transferInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"realm": {
"type": "string",
"enum": [
"FIAT",
"CRYPTO"
],
"description": "Realm (FIAT or CRYPTO).\n\n - FIAT: The traditional fiat banking world.\n - CRYPTO: The cryptocurrency world."
},
"cryptoNetwork": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"autoConversion": {
"type": "boolean",
"description": "True if this transfer will trigger PAX auto-conversion."
},
"sendToBank": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"aba": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"routingNumber": {
"type": "string",
"description": "The Paxos routing number."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress",
"bankAddress"
]
},
"swift": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the Paxos bank."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank or intermediary."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"senName": {
"type": "string",
"description": "The Paxos SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
}
},
"description": "The SEN transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The SIGNET transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The CBIT transfer instructions for depositing to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number/identifier."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "PaxosBankAccount is a bank account owned by Paxos and used by customers for\ndepositing fiat. Read-only."
},
"sendToAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "PaxosCryptoAddress is a crypto address owned by Paxos and used by customers\nfor depositing crypto."
}
}
}
}
},
"title": "Deposit instructions for a specific profile"
}
Deposit instructions for a specific profile
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| profileId | string | false | none | none |
| transferInstructions | [TransferInstructions] | false | none | none |
ProfileType
{
"type": "string",
"enum": [
"NORMAL",
"DEFAULT",
"SUB_CUSTOMER"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | NORMAL |
| anonymous | DEFAULT |
| anonymous | SUB_CUSTOMER |
Realm
{
"type": "string",
"enum": [
"FIAT",
"CRYPTO"
],
"description": "Realm (FIAT or CRYPTO).\n\n - FIAT: The traditional fiat banking world.\n - CRYPTO: The cryptocurrency world."
}
Realm (FIAT or CRYPTO).
- FIAT: The traditional fiat banking world.
- CRYPTO: The cryptocurrency world.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Realm (FIAT or CRYPTO). - FIAT: The traditional fiat banking world. - CRYPTO: The cryptocurrency world. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | FIAT |
| anonymous | CRYPTO |
SENDepositInstructions
{
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"senName": {
"type": "string",
"description": "The Paxos SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
}
},
"description": "The SEN transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"senName",
"accountNumber"
]
}
The SEN transfer instructions for depositing fiat to Paxos. Read-only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| memoId | string | true | none | A unique personal code for routing the deposited funds at Paxos. The customer should put this string in the transfer memo field, for any type of transfer. |
| senName | string | true | none | The Paxos SEN network name. |
| accountNumber | string | true | none | The Paxos account number. |
SENWithdrawalInstructions
{
"type": "object",
"properties": {
"senName": {
"type": "string",
"description": "The SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 20,
"pattern": "^[0-9A-Za-z]+$"
}
},
"description": "Instructions for a Silvergate Exchange Network (SEN) withdrawal.",
"required": [
"senName",
"accountNumber"
]
}
Instructions for a Silvergate Exchange Network (SEN) withdrawal.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| senName | string | true | none | The SEN network name. |
| accountNumber | string | true | none | The account number. |
SIGNETDepositInstructions
{
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The SIGNET transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
}
The SIGNET transfer instructions for depositing fiat to Paxos. Read-only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| memoId | string | true | none | A unique personal code for routing the deposited funds at Paxos. The customer should use memo_id in the transfer-memo field for all transfer types. |
| beneficiaryName | string | true | none | The Paxos entity name. |
| walletAddress | string | true | none | The Paxos wallet address. |
SIGNETWithdrawalInstructions
{
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The withdrawal beneficiary."
},
"walletAddress": {
"type": "string",
"description": "The wallet address."
}
},
"description": "Instructions for a SIGNATURE Network (SIGNET) withdrawal.",
"required": [
"beneficiaryName",
"walletAddress"
]
}
Instructions for a SIGNATURE Network (SIGNET) withdrawal.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| beneficiaryName | string | true | none | The withdrawal beneficiary. |
| walletAddress | string | true | none | The wallet address. |
SOLDepositInstructions
{
"type": "object",
"properties": {
"depositAddress": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| depositAddress | string | false | none | none |
SWIFTDepositInstructions
{
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the Paxos bank."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank or intermediary."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
}
The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| memoId | string | true | none | A unique personal code for routing the deposited funds at Paxos. The customer should put this string in the transfer memo field, for any type of transfer. |
| beneficiaryName | string | true | none | The Paxos entity name. |
| accountNumber | string | true | none | The Paxos account number. |
| swiftBic | string | true | none | The SWIFT Bank Identifier Code (BIC) of the Paxos bank. |
| bankName | string | true | none | The name of the Paxos bank or intermediary. |
| beneficiaryAddress | MailingAddress | true | none | A mailing address. |
| bankAddress | MailingAddress | false | none | A mailing address. |
SWIFTWithdrawalInstructions
{
"type": "object",
"properties": {
"beneficiaryName": {
"type": "string",
"description": "The name of the customer to credit.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"accountNumber": {
"type": "string",
"description": "The account number.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC).",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"bankName": {
"type": "string",
"description": "The name of the bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"forFurtherCredit": {
"type": "string",
"description": "Additional account ID. Optional.",
"maxLength": 105,
"pattern": "^[0-9A-Za-z /?:().,&'+-]*$"
},
"intermediary": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the intermediary bank.",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the intermediary bank.",
"maxLength": 11,
"minLength": 8,
"pattern": "^[0-9A-Za-z]+$"
},
"address": {
"type": "string",
"title": "The mailing address of the intermediary bank in one text box.\nAll printable characters. Synonymous to [\\x20-\\x7e]",
"maxLength": 105
}
},
"description": "An intermediary bank for SWIFT withdrawals.",
"required": [
"name",
"swiftBic"
]
}
},
"description": "Instructions for a SWIFT wire withdrawal.",
"required": [
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
}
Instructions for a SWIFT wire withdrawal.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| beneficiaryName | string | true | none | The name of the customer to credit. |
| accountNumber | string | true | none | The account number. |
| swiftBic | string | true | none | The SWIFT Bank Identifier Code (BIC). |
| bankName | string | true | none | The name of the bank. |
| beneficiaryAddress | MailingAddress | true | none | A mailing address. |
| forFurtherCredit | string | false | none | Additional account ID. Optional. |
| intermediary | SWIFTWithdrawalInstructionsIntermediary | false | none | An intermediary bank for SWIFT withdrawals. |
SecondaryStatus
{
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
},
"detail": {
"type": "string",
"description": "Additional information about the current status of the transfer (e.g. if information is missing)."
}
},
"description": "Secondary status for the transfer, used for more granular explanation of the transfer status."
}
Secondary status for the transfer, used for more granular explanation of the transfer status.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | SecondaryStatusName | false | none | Identifier for secondary status. - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer. |
| detail | string | false | none | Additional information about the current status of the transfer (e.g. if information is missing). |
SecondaryStatusName
{
"type": "string",
"enum": [
"TRAVEL_RULE_INFO_REQUESTED"
],
"description": "Identifier for secondary status.\n\n - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer."
}
Identifier for secondary status.
- TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Identifier for secondary status. - TRAVEL_RULE_INFO_REQUESTED: Travel rule information is required to continue processing the transfer. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | TRAVEL_RULE_INFO_REQUESTED |
TimestampRange
{
"type": "object",
"properties": {
"begin": {
"type": "string",
"format": "date-time",
"description": "Only return records after this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`."
},
"end": {
"type": "string",
"format": "date-time",
"description": "Only return records before this timestamp, inclusive. RFC3339 format, like `2006-01-02T15:04:05Z`."
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| begin | string(date-time) | false | none | Only return records after this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z. |
| end | string(date-time) | false | none | Only return records before this timestamp, inclusive. RFC3339 format, like 2006-01-02T15:04:05Z. |
TransferInstructions
{
"type": "object",
"properties": {
"realm": {
"type": "string",
"enum": [
"FIAT",
"CRYPTO"
],
"description": "Realm (FIAT or CRYPTO).\n\n - FIAT: The traditional fiat banking world.\n - CRYPTO: The cryptocurrency world."
},
"cryptoNetwork": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"autoConversion": {
"type": "boolean",
"description": "True if this transfer will trigger PAX auto-conversion."
},
"sendToBank": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"aba": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"routingNumber": {
"type": "string",
"description": "The Paxos routing number."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The ABA transfer instructions for depositing fiat to Paxos from a US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"routingNumber",
"bankName",
"beneficiaryAddress",
"bankAddress"
]
},
"swift": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
},
"swiftBic": {
"type": "string",
"description": "The SWIFT Bank Identifier Code (BIC) of the Paxos bank."
},
"bankName": {
"type": "string",
"description": "The name of the Paxos bank or intermediary."
},
"beneficiaryAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
},
"bankAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address1": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"address2": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"city": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"province": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
},
"zipCode": {
"type": "string",
"maxLength": 35,
"pattern": "^[0-9A-Za-z /?:().,&'+-]+$"
}
},
"description": "A mailing address.",
"required": [
"country"
]
}
},
"description": "The SWIFT transfer instructions for depositing fiat to Paxos from a non-US bank. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"swiftBic",
"bankName",
"beneficiaryAddress"
]
},
"sen": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should put this string in the transfer memo field, for any type\nof transfer."
},
"senName": {
"type": "string",
"description": "The Paxos SEN network name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number."
}
},
"description": "The SEN transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"senName",
"accountNumber"
]
},
"signet": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The SIGNET transfer instructions for depositing fiat to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"cbit": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"walletAddress": {
"type": "string",
"description": "The Paxos wallet address."
}
},
"description": "The CBIT transfer instructions for depositing to Paxos. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"walletAddress"
]
},
"intrabank": {
"type": "object",
"properties": {
"memoId": {
"type": "string",
"description": "A unique personal code for routing the deposited funds at Paxos.\nThe customer should use `memo_id` in the transfer-memo field for all transfer types."
},
"beneficiaryName": {
"type": "string",
"description": "The Paxos entity name."
},
"accountNumber": {
"type": "string",
"description": "The Paxos account number/identifier."
},
"type": {
"type": "string",
"enum": [
"ABA",
"SWIFT",
"SEN",
"ACH",
"SIGNET",
"CBIT"
],
"description": "The bank account type: The kind of transfer Paxos will perform for a withdrawal.\n\n - ABA: A U.S. domestic wire destination.\n - SWIFT: An international wire destination.\n - SEN: A destination on the \"Silvergate Exchange Network\" (between Silvergate accounts).\n - ACH: ACH\n - SIGNET: A destination on the Signet Platform (between Signature accounts).\n - CBIT: A destination on the CBIT Network (between Customers Bank accounts)."
}
},
"description": "The intra-bank deposit instructions for depositing to Paxos. Intra-bank includes CBIT. Read-only.",
"required": [
"memoId",
"beneficiaryName",
"accountNumber",
"type"
]
}
},
"description": "PaxosBankAccount is a bank account owned by Paxos and used by customers for\ndepositing fiat. Read-only."
},
"sendToAddress": {
"type": "object",
"properties": {
"network": {
"type": "string",
"enum": [
"NETWORK_BTC",
"NETWORK_ETH",
"NETWORK_BCH",
"NETWORK_LTC",
"NETWORK_SOL"
],
"description": "Crypto network."
},
"address": {
"type": "string"
}
},
"description": "PaxosCryptoAddress is a crypto address owned by Paxos and used by customers\nfor depositing crypto."
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| realm | Realm | false | none | Realm (FIAT or CRYPTO). - FIAT: The traditional fiat banking world. - CRYPTO: The cryptocurrency world. |
| cryptoNetwork | Network | false | none | Crypto network. |
| autoConversion | boolean | false | none | True if this transfer will trigger PAX auto-conversion. |
| sendToBank | PaxosBankAccount | false | none | PaxosBankAccount is a bank account owned by Paxos and used by customers for depositing fiat. Read-only. |
| sendToAddress | PaxosCryptoAddress | false | none | PaxosCryptoAddress is a crypto address owned by Paxos and used by customers for depositing crypto. |
WireDepositInstructions
{
"type": "object",
"properties": {
"depositMemo": {
"type": "object",
"properties": {
"memo": {
"type": "string"
},
"destinationAssetType": {
"type": "string",
"enum": [
"USD",
"BTC",
"ETH",
"PAX",
"PAXG",
"UNALLOCATED_GOLD",
"ALLOCATED_GOLD",
"BUSD",
"HUSD",
"EUR",
"SGD",
"BCH",
"LTC",
"USDP",
"AAVE",
"UNI",
"MATIC",
"PYUSD",
"LINK",
"SOL"
],
"description": "",
"title": "AssetType"
}
}
},
"bank": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"country": {
"type": "string"
},
"address": {
"type": "string"
},
"routingNumber": {
"type": "string"
},
"recipientName": {
"type": "string"
},
"recipientAddress": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"swiftIntermediaryBankName": {
"type": "string"
},
"swiftIntermediaryBankAddress": {
"type": "string"
},
"swiftCode": {
"type": "string"
}
}
}
},
"required": [
"depositMemo",
"bank"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| depositMemo | DepositMemo | true | none | none |
| bank | BankInformation | true | none | none |
CustomerAccountStatus
{
"type": "string",
"enum": [
"APPROVED",
"DISABLED",
"KYC_NOT_SUBMITTED",
"KYC_IN_PROGRESS"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | APPROVED |
| anonymous | DISABLED |
| anonymous | KYC_NOT_SUBMITTED |
| anonymous | KYC_IN_PROGRESS |
CustomerInstitutionality
{
"type": "string",
"enum": [
"INDIVIDUAL",
"INSTITUTION"
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | INDIVIDUAL |
| anonymous | INSTITUTION |
CustomerKycStatus
{
"type": "string",
"enum": [
"KYC_STATUS_NOT_STARTED",
"KYC_STATUS_IN_PROGRESS",
"KYC_STATUS_PROCESSING",
"KYC_STATUS_FAILED_JUMIO",
"KYC_STATUS_FAILED_COMPLYADVANTAGE",
"KYC_STATUS_DENIED",
"KYC_STATUS_PENDING",
"KYC_STATUS_PENDING_INSTITUTION",
"KYC_STATUS_APPROVED",
"KYC_STATUS_SET_FOR_CLOSURE"
],
"description": "TODO: Admins need more visibility into KYC status."
}
TODO: Admins need more visibility into KYC status.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | TODO: Admins need more visibility into KYC status. |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | KYC_STATUS_NOT_STARTED |
| anonymous | KYC_STATUS_IN_PROGRESS |
| anonymous | KYC_STATUS_PROCESSING |
| anonymous | KYC_STATUS_FAILED_JUMIO |
| anonymous | KYC_STATUS_FAILED_COMPLYADVANTAGE |
| anonymous | KYC_STATUS_DENIED |
| anonymous | KYC_STATUS_PENDING |
| anonymous | KYC_STATUS_PENDING_INSTITUTION |
| anonymous | KYC_STATUS_APPROVED |
| anonymous | KYC_STATUS_SET_FOR_CLOSURE |
CustStatus
{
"type": "object",
"properties": {
"kycStatus": {
"type": "string",
"enum": [
"KYC_STATUS_NOT_STARTED",
"KYC_STATUS_IN_PROGRESS",
"KYC_STATUS_PROCESSING",
"KYC_STATUS_FAILED_JUMIO",
"KYC_STATUS_FAILED_COMPLYADVANTAGE",
"KYC_STATUS_DENIED",
"KYC_STATUS_PENDING",
"KYC_STATUS_PENDING_INSTITUTION",
"KYC_STATUS_APPROVED",
"KYC_STATUS_SET_FOR_CLOSURE"
],
"description": "TODO: Admins need more visibility into KYC status."
},
"accountStatus": {
"type": "string",
"enum": [
"APPROVED",
"DISABLED",
"KYC_NOT_SUBMITTED",
"KYC_IN_PROGRESS"
]
},
"institutionality": {
"type": "string",
"enum": [
"INDIVIDUAL",
"INSTITUTION"
]
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kycStatus | CustomerKycStatus | false | none | TODO: Admins need more visibility into KYC status. |
| accountStatus | CustomerAccountStatus | false | none | none |
| institutionality | CustomerInstitutionality | false | none | none |
CustomerAddress
{
"type": "object",
"properties": {
"country": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"city": {
"type": "string"
},
"province": {
"type": "string"
},
"zipCode": {
"type": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| country | string | false | none | none |
| address1 | string | false | none | none |
| address2 | string | false | none | none |
| city | string | false | none | none |
| province | string | false | none | none |
| zipCode | string | false | none | none |
GetCustStatusResponse
{
"type": "object",
"properties": {
"custStatus": {
"type": "object",
"properties": {
"kycStatus": {
"type": "string",
"enum": [
"KYC_STATUS_NOT_STARTED",
"KYC_STATUS_IN_PROGRESS",
"KYC_STATUS_PROCESSING",
"KYC_STATUS_FAILED_JUMIO",
"KYC_STATUS_FAILED_COMPLYADVANTAGE",
"KYC_STATUS_DENIED",
"KYC_STATUS_PENDING",
"KYC_STATUS_PENDING_INSTITUTION",
"KYC_STATUS_APPROVED",
"KYC_STATUS_SET_FOR_CLOSURE"
],
"description": "TODO: Admins need more visibility into KYC status."
},
"accountStatus": {
"type": "string",
"enum": [
"APPROVED",
"DISABLED",
"KYC_NOT_SUBMITTED",
"KYC_IN_PROGRESS"
]
},
"institutionality": {
"type": "string",
"enum": [
"INDIVIDUAL",
"INSTITUTION"
]
}
}
},
"customerId": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"institutionName": {
"type": "string"
},
"officialName": {
"type": "string"
},
"address": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"city": {
"type": "string"
},
"province": {
"type": "string"
},
"zipCode": {
"type": "string"
}
}
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| custStatus | CustStatus | false | none | none |
| customerId | string | false | none | none |
| firstName | string | false | none | none |
| lastName | string | false | none | none |
| institutionName | string | false | none | none |
| officialName | string | false | none | none |
| address | CustomerAddress | false | none | none |