Create an internal transfer

POST

/transfer

POST

/api/v1/transfer

curl -X POST https://api.mercury.com/api/v1/transfer \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "amount": 1.1,
  "destinationAccountId": "string",
  "idempotencyKey": "string",
  "sourceAccountId": "string"
}'

{
  "creditTransaction": {
    "accountId": "string",
    "amount": 1.1,
    "attachments": [
      {
        "attachmentType": "checkImage",
        "fileName": "string",
        "url": "string"
      }
    ],
    "compliantWithReceiptPolicy": true,
    "counterpartyId": "string",
    "counterpartyName": "string",
    "createdAt": {},
    "dashboardLink": "string",
    "estimatedDeliveryDate": {},
    "glAllocations": [
      {
        "amount": 1.1,
        "glCodeName": "string",
        "description": "string"
      }
    ],
    "hasGeneratedReceipt": true,
    "id": "string",
    "kind": "externalTransfer",
    "relatedTransactions": [
      {
        "accountId": "string",
        "amount": 1.1,
        "id": "string",
        "relationKind": "ProvisionalCreditReversalToMerchantRefund"
      }
    ],
    "status": "pending",
    "bankDescription": "string",
    "categoryData": {
      "id": "string",
      "name": "string",
      "visibleForCardSpend": true,
      "visibleForOther": true,
      "visibleForReimbursements": true
    },
    "checkNumber": "string",
    "counterpartyNickname": "string",
    "creditAccountPeriodId": "string",
    "currencyExchangeInfo": {
      "convertedFromAmount": 1.1,
      "convertedFromCurrency": "USD",
      "convertedToAmount": 1.1,
      "convertedToCurrency": "USD",
      "exchangeRate": 1.1,
      "feeAmount": 1.1,
      "feePercentage": 1.1,
      "feeTransactionId": "string"
    },
    "details": {
      "address": {
        "address1": "string",
        "city": "string",
        "postalCode": "string",
        "address2": "string",
        "state": "AL"
      },
      "creditCardInfo": {
        "id": "string",
        "paymentMethod": "string",
        "email": "string"
      },
      "debitCardInfo": {
        "id": "string"
      },
      "domesticWireRoutingInfo": {
        "accountNumber": "string",
        "routingNumber": "string",
        "address": {
          "address1": "string",
          "city": "string",
          "country": "US",
          "postalCode": "string",
          "region": "CA",
          "address2": "string"
        },
        "bankName": "string"
      },
      "electronicRoutingInfo": {
        "accountNumber": "string",
        "electronicAccountType": "businessChecking",
        "routingNumber": "string",
        "address": {
          "address1": "string",
          "city": "string",
          "country": "US",
          "postalCode": "string",
          "region": "CA",
          "address2": "string"
        },
        "bankName": "string"
      },
      "internationalWireRoutingInfo": {
        "countrySpecific": {
          "australia": {
            "bsbCode": "string"
          },
          "brazil": {
            "legalId": "string"
          },
          "canada": {
            "bankCode": "string",
            "transitNumber": "string"
          },
          "chile": {
            "legalId": "string"
          },
          "colombia": {
            "legalId": "string"
          },
          "dominicanRepublic": {
            "accountType": "checking",
            "legalId": "string"
          },
          "honduras": {
            "accountType": "checking",
            "legalId": "string"
          },
          "india": {
            "ifscCode": "string"
          },
          "kazakhstan": {
            "legalId": "string"
          },
          "pakistan": {
            "legalId": "string",
            "legalIdType": "CNIC"
          },
          "paraguay": {
            "legalId": "string"
          },
          "philippines": {
            "routingNumber": "string"
          },
          "russia": {
            "inn": "string"
          },
          "southAfrica": {
            "branchCode": "string"
          }
        },
        "iban": "string",
        "swiftCode": "string",
        "address": {
          "address1": "string",
          "city": "string",
          "country": "US",
          "postalCode": "string",
          "region": "CA",
          "address2": "string"
        },
        "bankDetails": {
          "bankCityState": "string",
          "bankCountry": "US",
          "bankName": "string"
        },
        "correspondentInfo": {
          "bankName": "string",
          "routingNumber": "string",
          "swiftCode": "string"
        },
        "emailAddress": "string",
        "phoneNumber": "string"
      }
    },
    "externalMemo": "string",
    "failedAt": {},
    "feeId": "string",
    "generalLedgerCodeName": "string",
    "merchant": {
      "amount": 1,
      "category": "Other",
      "categoryCode": "string",
      "currency": "USD",
      "id": "string"
    },
    "mercuryCategory": "Other",
    "note": "string",
    "postedAt": {},
    "reasonForFailure": "string",
    "requestId": "string",
    "trackingNumber": "string"
  },
  "debitTransaction": {
    "accountId": "string",
    "amount": 1.1,
    "attachments": [
      {
        "attachmentType": "checkImage",
        "fileName": "string",
        "url": "string"
      }
    ],
    "compliantWithReceiptPolicy": true,
    "counterpartyId": "string",
    "counterpartyName": "string",
    "createdAt": {},
    "dashboardLink": "string",
    "estimatedDeliveryDate": {},
    "glAllocations": [
      {
        "amount": 1.1,
        "glCodeName": "string",
        "description": "string"
      }
    ],
    "hasGeneratedReceipt": true,
    "id": "string",
    "kind": "externalTransfer",
    "relatedTransactions": [
      {
        "accountId": "string",
        "amount": 1.1,
        "id": "string",
        "relationKind": "ProvisionalCreditReversalToMerchantRefund"
      }
    ],
    "status": "pending",
    "bankDescription": "string",
    "categoryData": {
      "id": "string",
      "name": "string",
      "visibleForCardSpend": true,
      "visibleForOther": true,
      "visibleForReimbursements": true
    },
    "checkNumber": "string",
    "counterpartyNickname": "string",
    "creditAccountPeriodId": "string",
    "currencyExchangeInfo": {
      "convertedFromAmount": 1.1,
      "convertedFromCurrency": "USD",
      "convertedToAmount": 1.1,
      "convertedToCurrency": "USD",
      "exchangeRate": 1.1,
      "feeAmount": 1.1,
      "feePercentage": 1.1,
      "feeTransactionId": "string"
    },
    "details": {
      "address": {
        "address1": "string",
        "city": "string",
        "postalCode": "string",
        "address2": "string",
        "state": "AL"
      },
      "creditCardInfo": {
        "id": "string",
        "paymentMethod": "string",
        "email": "string"
      },
      "debitCardInfo": {
        "id": "string"
      },
      "domesticWireRoutingInfo": {
        "accountNumber": "string",
        "routingNumber": "string",
        "address": {
          "address1": "string",
          "city": "string",
          "country": "US",
          "postalCode": "string",
          "region": "CA",
          "address2": "string"
        },
        "bankName": "string"
      },
      "electronicRoutingInfo": {
        "accountNumber": "string",
        "electronicAccountType": "businessChecking",
        "routingNumber": "string",
        "address": {
          "address1": "string",
          "city": "string",
          "country": "US",
          "postalCode": "string",
          "region": "CA",
          "address2": "string"
        },
        "bankName": "string"
      },
      "internationalWireRoutingInfo": {
        "countrySpecific": {
          "australia": {
            "bsbCode": "string"
          },
          "brazil": {
            "legalId": "string"
          },
          "canada": {
            "bankCode": "string",
            "transitNumber": "string"
          },
          "chile": {
            "legalId": "string"
          },
          "colombia": {
            "legalId": "string"
          },
          "dominicanRepublic": {
            "accountType": "checking",
            "legalId": "string"
          },
          "honduras": {
            "accountType": "checking",
            "legalId": "string"
          },
          "india": {
            "ifscCode": "string"
          },
          "kazakhstan": {
            "legalId": "string"
          },
          "pakistan": {
            "legalId": "string",
            "legalIdType": "CNIC"
          },
          "paraguay": {
            "legalId": "string"
          },
          "philippines": {
            "routingNumber": "string"
          },
          "russia": {
            "inn": "string"
          },
          "southAfrica": {
            "branchCode": "string"
          }
        },
        "iban": "string",
        "swiftCode": "string",
        "address": {
          "address1": "string",
          "city": "string",
          "country": "US",
          "postalCode": "string",
          "region": "CA",
          "address2": "string"
        },
        "bankDetails": {
          "bankCityState": "string",
          "bankCountry": "US",
          "bankName": "string"
        },
        "correspondentInfo": {
          "bankName": "string",
          "routingNumber": "string",
          "swiftCode": "string"
        },
        "emailAddress": "string",
        "phoneNumber": "string"
      }
    },
    "externalMemo": "string",
    "failedAt": {},
    "feeId": "string",
    "generalLedgerCodeName": "string",
    "merchant": {
      "amount": 1,
      "category": "Other",
      "categoryCode": "string",
      "currency": "USD",
      "id": "string"
    },
    "mercuryCategory": "Other",
    "note": "string",
    "postedAt": {},
    "reasonForFailure": "string",
    "requestId": "string",
    "trackingNumber": "string"
  }
}

Transfer funds between two accounts within the same organization. Supports transfers between depository accounts (checking/savings), from a depository account to a treasury/investment account, and from a treasury/investment account to a depository account. Creates paired debit and credit transactions.

Authentication

AuthorizationBearer

Bearer token authentication for Mercury API.

Use your API token in the Authorization header: Authorization: Bearer TOKEN

Example: Authorization: Bearer secret-token:mercury_production_wma_24SCp4G81X3yHL4Wq8FgzuaP9ye3VKf2mgTDctXyRg5HY_yrucrem

Your Mercury API token should include the ‘secret-token:’ prefix. Tokens can be generated from your Mercury dashboard settings.

Request

This endpoint expects an object.

amountdoubleRequired>=0.01

A positive dollar amount with at least 1 cent.

destinationAccountIdstringRequiredformat: "uuid"

ID for a Mercury account.

idempotencyKeystringRequired

sourceAccountIdstringRequiredformat: "uuid"

ID for a Mercury account.

notestring or nullOptional

Response

creditTransactionobject

A financial transaction on a Mercury account, including payment details, status, counterparty info, and categorization.

debitTransactionobject

A financial transaction on a Mercury account, including payment details, status, counterparty info, and categorization.

Errors

400

Bad Request Error