Get Started

Create a Payment

This action submits payments created by a Partner to Western Union Business Solutions.

Table - /payments

Resource Template
/customers/{customerId}/batches/
{batchId}/payments
Http Method PUT
Description

Used to submit payments created by a Partner to Western Union Business Solutions.

WUBS will return call immediately and will continue to process submitted payments asynchronously.

Can also be used to update payments in a ' Created' state.(currently not supported)

Payments initially submitted to WUBS are tagged as 'Created' and details are sent for preliminary scanning.

For all cases, payment identifier (paymentId) is created and assigned by a Partner and that value will be used to reference a payment for all other calls.

It's assumed that payment Id value will be unique on a customer level thus allowing multiple customers of a Partner to use the same payment id value for their payments.

NOTE: 'PUT' will be limited for total of 10000 payments per one request or 2Mb in size (whatever comes first).

Requests exceeding those limits will be rejected.

Description

Field Information ' bolded' fields depict 'required for release' fields. All other fields are optional.

'underlined' fields depict 'conditional' fields - one of them should be submitted, based on the other submitted field' value. There are conditional fields:

  1. If beneficiary 'type' is 'individual':
  • firstName' and 'lastName' should be provided.
    1. If beneficiary 'type' is 'business':
    • 'businessName' should be provided.
    1. Either a "bankCode" or "bankBranchCode" values should be provided.
    1. Third Party Remitter fields - all should be provided for a third party or none
    2. For US domestic 1, the bank account fields except Country are optional.
    3. The beneficiary’s ‘Tax ID’ must be provided if the payment currency (“currencyCode”) is ‘MXN’ (Mexican Pesos)
      The beneficiary’s ‘Tax ID’ is optional in all other cases.

    If entering a BIC / SWIFT code, please ensure that all letters are in UPPER CASE.

    The collection of payments should only have payments with all the required for release fields filled in.

    If any of required fields are missed, a payment will not be accepted.

    Input
    {
    payments":
    [
    {
    "partnerReference","","paymentMethod":"","id":"",
    "paymentReference":"","amount":,"currencyCode":"",
    "settlementCurrencyCode":"",
    "isFixedAmountInSettlementCurrency":"",
    "beneficiary":
    {
    "id":"","versionedOn":"","email":"",
    "type":"","taxId":"","firstName":"","middleName":"",
    "lastName":"","phoneNumber":"","cellNumber":"",
    "dateOfBirth":"","gender":"",
    "businessName":"","businessRegistrationNumber":"",
    "businessRegistrationCountry":"","businessRegistrationStateProv":"",
    "industry":"",
    "address":
    {
    "line1":"","line2":"","line3":"","city":"","stateOrProv":"",
    "zipOrPostal":"","countryCode":""
    },
    },
    "bankAccount":
    {
    "id":"","versionedOn":"","accountNumber":"","accountType":"",
    "bankName":"","bankBranchName":"","bankCode":"",
    "bankBranchCode":"",
    "address":
    {
    "line1":"","line2":"","line3":"","city":"",
    "stateOrProv":"","zipOrPostal":"","countryCode"
    },
    "intermediaryBank":
    {
    "bankName":"","bankCode":"","accountNumber":"",
    "bankBranchCode":"","address":
    {
    "line1":"","line2":"","line3":"","city":"",
    "stateOrProv":"","zipOrPostal":"","countryCode
    }
    }
    },
    purposeOfPayment":"","instructionForBank":"",
    "instructionCodeForBank":"","remittanceType":"",
    "remittanceData":
    [
    {
    "ref":""
    }
    ],  
    "thirdPartyRemitter":
    {
    "id":"","versionedOn":"","type":"",
    "businessName":"","address":
    {
    "line1":"","line2":"","line3":"",
    "city":"","stateOrProv":"","zipOrPostal":"",
    "countryCode":""
    },
    "email":"","phoneNumber":"","identificationType":"",
    "identification":"","industry": " 
    }
    }
    ]
    }
    Output
    202 Accepted
    {
    "receivedPayments":
    "<total Number of received payments>"
    }
    Output (errors)
    404 Not Found
     - if a submitted resource location is not found
    
    400 Bad Request
     - if collection of payment is invalid 
    (not present or not in valid format).
    Payments themselves will be validated later
    so a submitted payment with invalid
    details won't cause 400 status.

    * Payment is considered US domestic when all of following apply:

    1. Customer country must be in US geographical area (PR, GU, MP, VI, US).
    2. Beneficiary country must be in US geographical area.
    3. Beneficiary bank country must be in US geographical area.
    4. The trade & settlement currency must be USD.