API Reference

Payment Methods

Overview

🚧

Payment Method APIs still on v2

Please note that we are currently working on upgrading our Payment Method APIs. The APIs laid out in this document still have API v2 URLs. Our new APIs will include the functionality outlined here as well as additional functionality.

Payment Method resources are generic resources that represent a payment method connected to the financial system.

Payment Method Statuses

StatusDescription
PENDINGPayment Method has not been activated and is PENDING review on Wyre's side. No user action is required.
AWAITING_FOLLOWUPPayment Method requires additional information from the user before being useful. The case where you would see this is on WIRE_TRANSFER payment methods when the bank statement is still required.
ACTIVEPayment Method is active and ready for use.
REJECTEDPayment Method has been rejected by Wyre and cannot be used.

Payment Method Types

TypeLinkType valueDescription
WIRE_TRANSFERINTERNATIONAL_TRANSFERWire transfer
LOCAL_TRANSFERLOCAL_TRANSFERTransfer using the local banking system. Use for ACH or any of the other countries we support local transfers in.

Lifecycle and Exceptions

There are four edge cases that would trigger a user into a non approved state after submitting KYC information and connecting a bank account.

  1. A user needs to re-submit a piece of initial account information.
  2. User needs to re-submit an ID image
  3. A user needs to submit a Proof of Address
  4. A user needs to submit an ACH authorization form.

See also: Payment Method Edge Cases

Blockchain Attachment & Liquidation

The blockchains object as shown above, is made available through Attaching Blockchain to Payment Methods.

Payment methods may be connected to any of blockchains we support. This means that any transactions in supported currencies sent to that address will have their totals converted and liquidated to the payment method.

You may attach blockchain when creating payment methods by supplying a request parameter attachBlockchains as an array of currencies, or ALL for all presently available.

You may also attach the blockchains to existing payment methods with this endpoint.

"blockchains": {
      "BTC": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
      "ETH": "0x32Be343B94f860124dC4fEe278FDCBD38C102D88"
    }

Sample Payment Method

A Payment Method, as returned by the Wyre API, looks like this:

{
    "id": "PA-W7YN28ABCHT",
    "owner": "account:AC-XX38VYXUA84",
    "createdAt": 1542771684392,
    "name": "Plaid Checking 0000",
    "defaultCurrency": "USD",
    "status": "PENDING",
    "statusMessage": null,
    "waitingPrompts": [],
    "linkType": "LOCAL_TRANSFER",
    "beneficiaryType": "UNKNOWN",
    "supportsDeposit": true,
    "nameOnMethod": null,
    "last4Digits": "0000",
    "brand": null,
    "expirationDisplay": null,
    "countryCode": "US",
    "nickname": null,
    "rejectionMessage": null,
    "disabled": false,
    "supportsPayment": true,
    "chargeableCurrencies": [
        "USD"
    ],
    "depositableCurrencies": [
        "USD"
    ],
    "chargeFeeSchedule": null,
    "depositFeeSchedule": null,
    "minCharge": null,
    "maxCharge": null,
    "minDeposit": null,
    "maxDeposit": null,
    "documents": [],
    "srn": "paymentmethod:PA-W7YN28ABCHT",
  	"blockchains": {
      "BTC": "1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
      "ETH": "0x32Be343B94f860124dC4fEe278FDCBD38C102D88"
    }
}

📘

Payment Method Owner

The owner property of the payment method will normally be an account SRN belonging to a user, but it can also be a transfer SRN.