Payment Fields Definitions & Examples
Use the table below for definitions and examples of the payment fields used.
Payment fields
Field | Description |
---|---|
customerId |
Partner defined Id used to uniquely identify a customer within the Partner's system. Type: Core,Required Format: string,up to 38 chars Example: 25892e17-80f6-415f-9c65-7395632f0223 |
partnerReference | Partner specific reference for a payment Type:Optional Format:string,up to 50 chars Example: |
paymentMethod | One of the supported payments methods. May 2020 - New SDA Validation Rules:
Type: Required Format: string Example: wire, ach, SDA (same day ACH) |
id | Partner defined Id used to uniquely identify a payment within Partner system Type: Required Format: string, up to 38 chars Example: 25892e17-80f6-415f-9c65-7395632f0224 |
status | WUBS defined payment status. Only available in payment resource response. |
createdOn | WUBS generated timestamp when a payment was accepted. In UTC timezone. Only available in payment resource response Type: Format: timestamp Example: 2015-01-15T13:04:34Z |
lastUpdatedOn | WUBS generated timestamp when a payment was accepted. In UTC timezone. Only available in payment resource response Type: Format: timestamp Example: 2015-01-15T13:04:34Z |
errorCode | WUBS defined errorCode. Could be presented for accepted payments which failed to be released. Only available in payment resource response Type: Format: <int:[reason_or_field]> Example: 1003:paymentMethod |
UpdateErrorCode | WUBS defined errorCode. Could be presented for an originally accepted payment for which a subsequent update request was not successful. ErrorCode will indicate the reason update has failed. Only the latest update errorCode will be presented. Only available in payment resource response Type: n/a Format: <int:[reason_or_field]> Example: 1104 |
UpdateErrorOn | WUBS generated timestamp when a requested payment's update was not successful. In UTC timezone. In case of multiple failed updates, the timestamp will be for the latest one. Only available in payment resource response Type: n/a Format: timestamp Example: 2015-01-15T13:04:34Z |
amount | Payment amount expressed in cents *.
*4234400 would mean 42344.00 for USD currency or 4234.400 for BHD or 4234400 JPY Type: Required Format: int Example:4234400 |
currencyCode | Payment's currency code Type: Required Format: string, char(3) Example: USD |
settlement Amount | Amount in settlement currency, expressed in cents *. If isFixedAmountInSettlementCurrency flag was submitted as 'true' - will be the amount provided as part of payment submission. If not - will be calculated from submitted payment amount as part of batch commit using quoted exchange rate. * 4234400 would mean 42344.00 for USD currency or 4234.400 for BHD or 4234400 JPY Type: Format: int Example: 4234400 |
settlementCurrencyCode | Currency Code of a settlement used to fund this particular payment Type: Optional Format: string, char(3) Example: GBP |
isFixedAmountInSettlementCurrency | Indication if payment was submitted with settlement amount specified. If not provided as part of payment submission, a 'false' value will be used, indicating that provided amount is payment amount. Type: Optional Format: string, boolean value Example: true/false |
isDoddFrank | Flag to force treatment of payment as Dodd-Frank. Customer required to pass as “true” for Sole Proprietors beneficiaries that meet Dodd-Frank purpose of payments Type: Optional Format: Boolean Example: True |
beneficiary | Structure to hold beneficiary specific values for a payment Type: Required |
id | Partner defined Id used to uniquely identify a beneficiary within Partner system Type: Required Format: string, up to 38 chars Example: 7395632f0225 |
versionedOn | Partner provided timestamp indicating when beneficiary details were last updated. UTC timezone should be used. Type: Required Format: timestamp Example: 2015-01-15T13:04:34Z |
Beneficiary email Type: Optional Format: string Example: test@test.com |
|
type | One of the supported beneficiary types: 1. "individual" Type: Required Format: string, individual / sole proprietor / business Example: individual |
taxId | Required if the payment currency (“currencyCode”) is ‘MXN’ (Mexican Pesos). Optional in all other cases. Type: Conditional Format: string, up to 35 chars Example: MALA780724988 |
firstName | Required for individual beneficiary type. Sole proprietor beneficiary type requires full name (firstName and lastName) or businessName Type: Conditional Format: string, Combination of first, middle and last name cannot be greater than 70 chars. Example: Warren |
middleName | Optional for individual beneficiary type Type: Optional Format: Example: M. |
lastName | Required for individual beneficiary type. Sole proprietor beneficiary type requires full name (firstName and lastName) or businessName Type: Conditional Format: string Example: Houston |
phoneNumber | Main phone number of a beneficiary (home or business) Type: Optional Format: string Example: 643-637-0319 |
cellNumber | Mobile phone number of a beneficiary Type: Optional Format: string Example: 643-637-0319 |
dateOfBirth | Beneficiary's date of birth Type: Optional Format: string YYYY-MM-DD Example: 1966-06-11 |
gender | Beneficiary's gender (for individual beneficiary type) Type: Format: string Example: male |
businessName | Required for business beneficiary type. Sole proprietor beneficiary type requires full name (firstName and lastName) or businessName Type: Conditional Format: string, Conditional: Not required if entity is 'Individual'. If required, must be either 'Business' or 'Company' type Example: Odio Phasellus Corporation |
businessRegistrationNumber | country specific registration number Type: Optional Format: string, up to 80 chars Example: 94936 |
businessRegistrationCountry | country where beneficiary business is registered Type:Optional Format: string Example: US |
businessRegistrationStateProv | country's province or state where beneficiary business is registered Type: Optional Format: string Example: CA |
industry | beneficiary business industry type Type: Optional Format: string E xample: Finance |
address | Structure to hold beneficiary address details Type: Required |
line1 street address, up to 35 char Type: Conditional Format: string Example: 6758 Maecenas Road |
|
line2 street address Type: Optional Format: string Example: |
|
line3 street address Type: Optional Format: string Example: |
|
city name Type: Conditional Format: string, up to 35 chars Example: Darlington |
|
stateOrProv T ype: Conditional Format: string, up to 35 chars Example: CA |
|
zipOrPostal code Type: Conditional Format: string, up to 16 chars Example:12345 |
|
countryCode Type: Required Format: string, 2 char Example: US |
|
bankAccount | Structure to hold beneficiary bank account details Type: Required |
id | Partner defined Id used to uniquely identify a beneficiary account within Partner system Type: Required Format:string, up to 38 chars Example: 25892e17-80f6-415f-9c65-7395632f0226 |
versionedOn | Partner provided timestamp when bank account details were last updated. UTC timezone should be used. Type: Required Format: timestamp Example: 2015-01-15T13:04:34Z |
accountNumber | IBAN or account number depending on the context Type: Required Format: string, up to 34 chars Example: 29651 |
accountType | One of the supported bank account types: savings/checking Type: Optional Format: string, savings / checking Example: checking |
bankName | Beneficiary bank name Type: Required Format: string, up to 140 chars Example: Humoungous Bank Inc. |
bankBranchName | Beneficiary bank branch name Type: Format: string Example: 98906 |
bankCode | BIC or SWIFT code depending on the context. Please ensure that all letters are in UPPER CASE. Type: Conditional Format: string, Regex with [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} Example: ABCDCA2DXXX |
bankBranchCode | Routing or transit code depending on the context. Please ensure that all letters are in UPPER CASE. Type: Conditional Format: string Example: 30168 |
address | Structure to hold beneficiary's bank address details Type: Required |
line1 street address Type: Conditional Format: string, up to 35 char Example: 4837 Pell Avenue |
|
line2 street address Type: Optional Format: string Example:n/a |
|
line3 street address Type: Optional Format: string Example: |
|
city name Type: Conditional Format: string, up to 35 char Example: Bolton |
|
stateOrProv Type: Conditional Format: string, up to 35 char Example: CA |
|
zipOrPostal code Type: Conditional Format: string, up to 16 char Example: 12345 |
|
countryCode Type: Required Format: string, 2 char Example: US |
|
intermediaryBank | structure to hold details of intermediary bank Type: Optional |
bankName intermediary bank name Type: Optional Format: string Example: VC Vancouver Capitol Bank Inc. |
|
bankCode Intermediary bank code (BIC or SWIFT code depending on the context). Please ensure that all letters are in UPPER CASE. T ype: Optional Format: string, Regex with [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} Example: 29685 |
|
accountNumber IBAN or account number depending on the context Type: Optional Format: string, up to 34 char Example: 767333 |
|
bankBranchCode Bank branch code for intermediary bank Type: Optional Format: string Example:12345 |
|
address | Structure to hold intermediary bank address details Type: Optional |
line1 street address Type: Optional Format:string, up to 35 char Example: 48 East St. |
|
line2 street address Type: Optional Format: string Example: n/a |
|
line3 street address Type: Optional Format: string Example: n/a |
|
city name Type: Optional Format: string, up to 35 char Example: Martello |
|
stateOrProv Type: Optional Format: string, up to 35 char Example: CA |
|
zipOrPostal code Type: Optional Format: string, up to 16 char Example: 12345 |
|
countryCode Type: Optional Format: string, 2 char Example: US |
|
purposeOfPayment | Purpose of payment as submitted by a customer Type: Optional Format: string Example: payment to a vendor 1234567 |
InstructionForBank | Instruction for bank - usually provided by a beneficiary Type: Optional Format: string Example: X407M2TR0R0PVVTUT |
InstructionCodeForBank | Instruction for bank - usually provided by front end beneficiary. Used to fill in bank details. Potential values: CHQB, HOLD, PHOB, TELB, URGP, OTHR. If other values (or nothing) provided, 'OTHR' will be used for bank files Type: Optional Format: string Example: OTHR |
paymentReference | For IAT and CCD payments. A message to the beneficiary about the payment. The recommended length of this field is 140 characters. If reference is too long, it may arrive incomplete. Type: Optional Format: string, 140 chars Example: 298746' or 'birthday gift' |
remittanceType | Remittance type value, one of "IAT", "CCD", "CTX", applicable for payments to business type beneficiary Type: Optional Format: string Example: CCD |
remittanceData | For CTX payments only. Remittance data to hold remittance details - supporting up to 9999 ref fields Type: Optional Format: Example: |
ref | free form text, up to 140 chars each Type: Optional Format: string, 140 chars Example: ULANJQQKSWI05YV64Y5 |
thirdPartyRemitter | Third Party Remitter Details. All the conditional fields are required if party is provided. Type: Conditional |
id | partner defined id used to uniquely identify a 3rd party remitter within the partner system Type: Conditional Format: string Example: 25892e17-80f6-415f-9c65-7395632f0226 |
VersionedOn | Partner provided timestamp of when a third party details were last updated. UTC timezone should be used. T ype: Conditional Format: string Example: 2016-01-15T13:04:34Z |
type | one of the supported 3rd party remitter types 1."partnership" 2."corporation" 3, "individual" 4. "sole proprietor" Type: Conditional Format: string, partnership / corporation / individual /sole proprietor Example: Corporation |
businessName | 3rd party remitter business name Type: Conditional Format: string Example: Odio Phasellus Corporation |
address | structure to hold 3rd party address |
line1 street address Type: Conditional Format: string Example: 4837 Pellentesque. Avenue |
|
line2 street address Type: Optional Format: string Example: n/a |
|
line3 street address Type: Optional Format: string Example: n/a |
|
city name Type: Conditional Format: string Example: Bolton |
|
stateOrProv Type: Conditional Format: string Example: CA |
|
zipOrPostal code Type: Conditional Format: string Example: 12345 |
|
countryCode Type: Conditional Format: string, char(2) E xample: US |
|
3rd party remitter email address Type: Optional Format: Example: test@test.com |
|
phoneNumber | 3rd party remitter phone number Type: Optional Format: string Example: 640-637-0319 |
identificationType | identification type: ex. "business registration number" Type: Optional Format: string Example: Business Registration Number |
industry | 3rd party business industry type Type: Optional Format: string Example: Financial Institution |
originatingFI | Structure to hold Originating Financial Institution information. Only accessible to third-party remitter enabled accounts. Type: Conditional |
Id | Partner-defined ID used to uniquely identify an Originating FI within the partner system. Type: Conditional Format: string Example: 25892e17-80f6-415f-9c65-7395632f0227 |
versionedOn | Copy from bankAccount Type: Conditional Format: timestamp Example: 2021-01-15T13:04:34Z |
accountNumber | Copy from bankAccount Type: Conditional Format:string, up to 34 chars Example: 29651 |
accountType | Copy from bankAccount Type: Conditional Format: string, savings / checking Example: checking |
bankName | Originating FI bank name Type: Conditional Format: string, up to 140 chars Example: Humoungous Bank Inc. |
bankCode | Copy from bankAccount Type: Conditional Format: string, Regex with [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} Example: ABCDCA2DXXX |
Address | Structure to hold Originating FI address information
|
Line1 | Type: Conditional Format: string, up to 35 char Example: 4837 Pellentesque Avenue |
Line2 | Type: Conditional Format: string |
Line3 | Type: Conditional Format: string |
City | Type: Conditional Format: string, up to 35 char Example: Bolton |
stateorProv | Type: Conditional Format: string, up to 35 char Example: CA |
zipOrPostal | Type: Conditional Format: string, up to 35 char Example: CA |
countryCode | Type: Conditional Format: string, 2 char Example:US |
chargeType | Selectable charge type for payment with the following options: BEN: Beneficiary is responsible for the payment charges SHA: The payment charges are shared with Customer and beneficiary OUR: Payment costs are the responsibility of WUBS |
valueDate | Scheduled date for credit to beneficiary bank account Type: Optional Format: string, YYYY-MM-DD Example: 2020-10-01 |