Contact Us
Skip Navigation LinksHome > Payment Batch  

Payment Batch

The Payment Batch URL is the gateway into Payment functionality in PayFac. Here you can request, submit and validate Payment Batches.

  • View or download the request schema, this XML format is required for all POST methods relating to Payment Batches
  • The response schema defines the XML format that is returned for all method calls relating to Payment Batches

See the links on the right for specific documentation about each method, and below the XML schema is described.

Element Descriptions

Field Name Length Description
<BatchType>   Required. Currently supported BatchTypes are "BCS", this will create a Bacs Payment Batch, and "PMT", this will create an International Payment Batch, and "MCP".
<CustomerReference> 250 Optional. An internal reference field to help with reconciliations in your internal systems.
<Fee>   Ignored for input. Payment Batch Fee.
<PaymentBatchLink>   Ignored for input. An encoded link to the Payment Batch page in PayFac.
<PaymentBatchNumber>   Ignored for input. The unique Payment Batch Number assigned when Payment Batch is booked.
<PaymentBatchReference>   Ignored for Input. PayFac reference, use in GetPaymentBatch to retrieve Payment Batch.
<PaymentDate>   Optional. Used for Bacs Payment Batches only. The date this Payment Batch should be paid. If null the next available Payment Date will be assigned.
<PaymentLines>   Required. At least one Payment Line must be added.
<PaymentLine>   PaymentLine Details.
<Amount> 18.2 Required. The amount paid to specified Beneficiary.
<Beneficiary>   Optional for Forward Contracts otherwise required.
<Address >   Required for Foreign Payments.
<BuildingName> 150 Optional. Name of building or street number of beneficiary
<City> 50 Required. City of beneficiary.
<Country> 255 Required. Country of beneficiary.
<PostCode> 20 Optional. Postal Code/ZIP Code of beneficiary and sensible to have for cheque delivery
<Street> 150 Required. Street Address of beneficiary
<BankAccount>   Required for Bacs or wire payments. Not required for Cheque payments.
<AbaAch> 100 Optional. For US NUP payments this is a required field depending specific rules required dependent on currency, delivery method and country of delivery. (Use the Currency Payment Requirements document).
<AccountNumber> 100 Required. Specific rules dependent on currency, delivery method and country of delivery. (Use the Currency Payment Requirements document).
<Address>   Required.
<BuildingName> 150 Optional. Name of building or street number of beneficiary bank
<City> 50 Required. City/Town location of beneficiary bank.
<Country> 255 Required. Country Name or Code of beneficiary bank. Use Country Codes provided.
<PostCode> 20 Optional. Postal Code/ZIP Code of beneficiary bank.
<Street> 150 Required. Street Address of beneficiary bank.
<BankAccountTypeCode> 3 Option. Required field for NUP payments, supported values are CRN or SAV.
<BankName> 50 Required. Name of beneficiary bank.
<CorrespondentBank>   Optional.
<AccountNumber> 100 Optional. Specific rules required dependent on currency, delivery method and country of delivery. (Use the Currency Payment Requirements document). *Either swift or Routing code must be provided.
<Address>   Required.
<BuildingName> 150 Optional. Name of building or street number of correspondent bank.
<City> 50 Required. City/Town location of correspondent bank.
<Country> 255 Required. Country Name or Code of correspondent bank. Use Country Codes provided.
<PostCode> 20 Required. Postal Code/ZIP Code of correspondent bank.
<Street> 150 Required. Street Address of correspondent bank.
<BankAccountTypeCode>   Optional.
<BankName> 50 Required. Name of correspondent bank.
<RoutingCode> 100 Optional. *Either swift or Routing code must be provided for correspondent bank.
<SwiftCode> 100 Required. *Either swift or Routing code must be provided for correspondent bank.
<RoutingCode> 100 Optional. Required for Bacs Payments. Specific rules required dependent on currency, delivery method and country of delivery. (Use the Currency Payment Requirements document). *Either swift or Routing code must be provided.
<SpecialInstructions> 150 Optional. For wire payments this is used for “Further Credit To” information or bank to bank information.
<SwiftCode> 100 Optional. Specific rules required dependent on currency, delivery method and country of delivery. (Use the Currency Payment Requirements document). *Either swift or Routing code must be provided.
<BeneficiaryId>   Required. Beneficiary unique identifier for this Beneficiary. Used to track updates to Beneficiary.
<BeneficiaryIdentificationNumber> 50 Optional.
<BeneficiaryTaxId> 50 Optional. This field may be required dependent on currency, delivery method and country of delivery. (Use the Currency Payment Requirements document).
<DateOfBirth> 8 Optional. Used for Compliance procedures and may be requested. If you have this information upfront this will help with reducing delays in payment processing. Date format is YYYYMMDD
<EmailAddess> 250 Optional. Email can be sent to the beneficiary advising them that the payment is on the way and providing them with the reference information relating to this payment.
<Name> Required. 100 Name of the Beneficiary.
<Nationality> 100 Optional. Used for Compliance procedures and may be requested. If you have this information upfront this will help with reducing delays in payment processing.
<ShortName> 50 Optional. Any specific name or code you use for you beneficiary that will appear in the PayFac beneficiary pick list.Defined by your system and is usually something which can help your team identify the beneficiary in the PayFac trade beneficiary pick list.
<PhoneNumber> 50 Optional. This field may be required dependent on currency, delivery method and country of delivery. (Use the Currency Payment Requirements document).
<BuyCurrencyCode> 3 Required. The currency that you are buying.
<ChargesTypeCode> 3 Optional. This defines who covers the cost of the intermediary bank and beneficiary bank charges being deducted from the payment. (Use the Currency Payment Requirements document to help support which charges codes are available for the currency and delivery method used)
<ConvertedAmount>   Ignored for Input. For foreign payments the Amount field is converted by the exchange rate and returned here.
<CustomerPaymentReference> 140 Optional. An internal reference field to help with reconciliations in your internal systems. This field will not be sent with the payment or appear on any statements.
<DeliveryMethodCode> 3 Required. Use Delivery Method Codes provided.
<DirectionCode> 3 or 4 Required. Must be either Buy or Sell.
<ExchangeRate>   Ignored for input.
<Fee>   Ignored for Input. Fee per line.
<FirstDeliveryDate> 8 Optional. When supplied along with a ValueDate a Window Forward COntract will be created/quoted.
<FwdContractNumber> 8 Optional. Only required when you have forward contracts in place and you are drawing payments from these contracts.
<PaymentCode> 50 Optional. This field may be required dependent on currency, delivery method and country of delivery. (Use the Currency Payment Requirements document and supporting ACH/SEPA Code documents).
<PaymentStatusCode>   Ignored for input. The current status of the Payment in PayFac is returned here.
<QuoteCode>   Optional. A quote code can be obtained from the ValidatePaymentBatch method and passed to the SubmitPaymentBatch method. When valid, exchange rates will be given as quoted. Invalid or expired Quote Codes will return an error.
<ReasonForPayment> 200 Optional. This field may be required dependent on currency, delivery method and country of delivery. (Use the Currency Payment Requirements document)
<Reference> 140 Optional. The reference you would like to appear on the beneficiary's bank statement.
<SellCurrencyCode> 3 Required. The currency that you are selling.
<ValidationMessages>   When a PaymentLine fails validation there may be a number or reasons for the failure. Each validaion issue will be listed below this element.
<ValidationMessage>   This element groups the various detail elements for a single validation failure.
<ErrorMessage>   This error message can be displayed to the end user.
<ValidationRuleCode>   Use this code to identify the validation issue in code.
<ValidationSuggestions>   Where a code is required for a payment and a list of valid codes is available the codes will be listed under this element.
<ValidationSuggestion>   Each possible option for the invalid field will be listed as a seperate element.
<Name>   The display name that describes the Value field below. This field is not currently in use but will be populated in future releases.
<Value>   The suggested or a possible value for this field.
<ValidationStatus>   ValidationStatus.
<ValueDate>   Optional. When present a Forward Contract will be created/quoted.
<WhenDueForProcessing>   Processing Date. Choose the date you would like this payment line to be processed. Format: yyyy-mm-dd.
<StatusCode>   Ignored for Input. StatusCode returned wil be one of:
INCM - Incomplete
PAUT - Pending Authorisation
BKED - Booked
<StatusReport>   Ignored for Input. Returns detail of validation problems or changes to PaymentDate.
<WhenBooked>   Ignored for Input. Date the Payment has been booked.