Create Payment

post

https://api-sandbox.paymentlabs.io/batches/{batchId}/payments

Creates a payment in a batch

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

batchId

string

required

Body Params

referenceId

string

External Payment Reference Id
This is used to cross reference this payment between both systems, you should set this the same as the payment id in your own system

payeeReferenceId

string

External Payee Reference Id
This is used to cross reference the payee between both systems, you should set this the same as the payee id in your own system
Import Info: Payee Reference Id

The payee reference id must be unique per payee
Reusing an ID with a different email will transfer access to the new email
If left blank, a new unique ID will be generated

To ensure accurate processing, verify the Payee Reference ID before completing the import or create process. If in doubt, leaving the field empty is the recommended action.

payeeEmail

string

The payee's email

sourceAmount

string

required

The amount to be paid

taxJurisdiction

string

enum

Tax rules to apply to this payment

Required if the you have multiple tax rules
validated against what jurisdictions are turned on for you

Allowed:

paymentCategory

string

enum

Payment category to be used for this payment

payeeMemo

string

Message to be sent to the payee when the payment is made

payorMemo

string

Message to be displayed to you on this payment

ledgerAccount

string

required

Your ledger account Id to be used for this payment

paymentMethodId

string

Payment method Id to be used for this payment

201The payment has been created

401Unauthorized response, when the user is not authenticated or the authentication token is missing in the header.

403 Forbidden response, when the user is authenticated but does not have the necessary permissions.