Home > Payment Batch > Submit Payment Batch

Submit Payment Batch

Use this method to create Payment Batches in PayFac.

There are a number of possible success and failure scenarios based on account setup.

Valid Payment Batches

Successfully validated submissions will create a single International Payment Batch and/or multiple Forward Contracts depending on the data provided.

If the user submitting the Payment Batch has permission to Book Payment Batches and where there is no Authorisation Workflow on the account for Payment Batches the Payments will be booked. Agreed exchange rates and the Payment Batch Number will be populated in the response.
If an Authorisation Workflow is in place Payment Batches will be set to Pending Authorisation and emails will be sent to prospective Authorisers advising that action is required within PayFac.
Where a user does not have permission to book Payment Batches and there is no workflow the Payment Batch(s) will be returned with a status of Incomplete.

Accounts may be configured in PayFac such that invalid Payment Batches are treated in one of two ways.

Where an account is configured to fail the entire Payment Batch then no Payments are created in PayFac. Valid lines will be returned with the Valid status and Invalid Payments will have detailed validation messages returned.
Where an account is configured to allow partial uploads, valid Payments will be created in PayFac and returned as above in the case of Valid Payment Batches. Invalid Payments will not be created as Payments in PayFac and will be returned in a separate Payment Batch element with detailed validation messages.

Duplicated requests from accounts with enabled ‘Prevent Duplicate Payments’ feature flag will be captured, to avoid processing duplicated payments.

Request uniqueness will be ensured by including a unique identifier (Idempotency-Key) in the header of the API call
Before processing the API request, the GUID will be checked:
- if the GUID appears for the first time - the request will be processed.
- if the GUID already exists for that client account in our system - the request will be rejected with appropriate response (Duplicated Idempotency-Key was passed in HTTP Header) and error code (HTTP 409 - Conflict)

Where account has enabled ‘Prevent Duplicate Payments’ feature flag:

An Idempotency-Key header is required in the following format: Idempotency-Key: Globally Unique Identifier(GUID)
Request without required header will be rejected with appropriate response (Missing required HTTP header: Idempotency-Key) and error code (HTTP 400 - Bad Request)

Use the HTTP POST method with the url below:

https://api.payfac.com/api.svc/paymentBatch/

An authorisation header is required in the following format: Authorization : username:AccountKey
Where account has enabled ‘Prevent Duplicate Payments’ feature flag an Idempotency-Key header is required in the following format: Idempotency-Key: Globally Unique Identifier(GUID)
The certificate used for mTLS authentication must be included in the request
The request schema and request example show the XML format required by this method
The response schema and response example define the XML format that is returned for this method