Payment methods

Set PaymentMethod in POST /paymentRequests to choose how Vitesse sends a direct payment.

Supply the bank account, email or address required for that method in Recipient, or reference a stored recipient in the request’s StoredRecipient property.

For the complete list of payment methods, see List payment methods.

For a programme-based flow, see List payment methods permitted for a programme to check by programme, country, currency and field scope.

Bank account

Set PaymentMethod to BankAccount. Supply the bank account identifiers in Recipient.BankAccount, or use a stored recipient containing those identifiers.

The required identifiers depend on the destination country and currency. The following examples show parts of a payment request.

UK bank account

For a payment to a UK bank account, supply the sort code and account number:

{
  "PaymentMethod": "BankAccount",
  "Recipient": {
    "BankAccount": {
      "SortCode": "123456",
      "AccountNumber": "12345678"
    }
  }
}

EUR payment using an IBAN

This example specifies a payment from a GBP account to a recipient’s account in the Netherlands. Use ReceiveValue to specify the amount the recipient should receive in EUR. Vitesse calculates the corresponding amount to debit in GBP.

{
  "SendCurrency": "GBP",
  "ReceiveCurrency": "EUR",
  "ReceiveValue": 100.50,
  "PaymentMethod": "BankAccount",
  "Recipient": {
    "Type": "Person",
    "Name": "Jane Doe",
    "Country": "NL",
    "BankAccount": {
      "Iban": "NL91ABNA0417164300"
    }
  }
}

Other destinations may require additional identifiers, such as Swift, or a recipient address. Check the applicable Rules for the destination country and currency.

Cheques

Vitesse issues eChecks and postal cheques in USD to recipients in the US.

Set ReceiveCurrency and Recipient.Country to USD and US, respectively. Both methods require a structured US address in Recipient.Address. Leave Recipient.BankAccount out of cheque payments.

For the address format, see Structured addresses​.

eCheck

Set PaymentMethod to Echeck on the payment request. Supply Recipient.Email for delivery as well as the recipient's structured US address. Although Vitesse emails the eCheck, the address is still required.

This partial request shows an eCheck payment with recipient details supplied directly in Recipient:

{
  "PaymentMethod": "Echeck",
  "Recipient": {
    "Type": "Person",
    "Name": "Emily Carter",
    "Email": "[email protected]",
    "Country": "US",
    "Address": {
      "StreetName": "Main Street",
      "BuildingNumber": "742",
      "City": "Springfield",
      "PostalCode": "62704",
      "CountrySubDivision": "IL",
      "Country": "US"
    }
  }
}

Postal cheque

Set PaymentMethod to PostalCheque on the payment request. Supply the recipient's name and structured US mailing address. Recipient.Email is not needed for postal delivery.

This partial request shows a PostalCheque payment with recipient details supplied directly in Recipient:

{
  "PaymentMethod": "PostalCheque",
  "Recipient": {
    "Type": "Person",
    "Name": "Michael Thompson",
    "Country": "US",
    "Address": {
      "StreetName": "Oak Avenue",
      "BuildingNumber": "118",
      "City": "Boston",
      "PostalCode": "02116",
      "CountrySubDivision": "MA",
      "Country": "US"
    }
  }
}

To create a complete request using one of these methods, see Make an immediate payment.