Create Payment

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

Creates a payment in a batch

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

payeeEmail

string

The payee's email

sourceAmount

string

required

The amount to be paid

taxJurisdiction

string

Tax rules to apply to this payment

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

paymentCategory

string

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

Responses

Response body

object

string

required

This payment's unique identifier

batchId

string

required

The batch (payment grouping) id

batchName

string

The batch (payment grouping) name

referenceId

string

required

External Payment Reference Id
This is used to cross reference this payment between both systems

ledgerAccount

string

The ledger account id used to pay 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

submitted

boolean

required

If this payment has been submitted for processing

completed

boolean

required

If this payment has been completed (paid)

sourceAmount

object

required

The amount to be paid

value

number

required

The amount in float point value

currency

string

required

The currency in ISO format

formattedValue

string

required

The formatted value with currency

digits

number

required

Decimal digits for the currency

wholeValue

number

required

The value, without any float points
Usually how many cents, depending if the currency has cent

destinationAmount

object

The amount to be paid in the destination currency

value

number

required

The amount in float point value

currency

string

required

The currency in ISO format

formattedValue

string

required

The formatted value with currency

digits

number

required

Decimal digits for the currency

wholeValue

number

required

The value, without any float points
Usually how many cents, depending if the currency has cent

refundAmount

object

The amount refunded for this payment

value

number

required

The amount in float point value

currency

string

required

The currency in ISO format

formattedValue

string

required

The formatted value with currency

digits

number

required

Decimal digits for the currency

wholeValue

number

required

The value, without any float points
Usually how many cents, depending if the currency has cent

paymentCategory

string

Payment category to be used for this payment

taxJurisdiction

string

Tax rules to apply to this payment

fi none us

chargedServiceFee

object

The total amount of service fee charged for this payment

value

number

required

The amount in float point value

currency

string

required

The currency in ISO format

formattedValue

string

required

The formatted value with currency

digits

number

required

Decimal digits for the currency

wholeValue

number

required

The value, without any float points
Usually how many cents, depending if the currency has cent

refundedServiceFee

object

The total amount of service fee refunded for this payment

value

number

required

The amount in float point value

currency

string

required

The currency in ISO format

formattedValue

string

required

The formatted value with currency

digits

number

required

Decimal digits for the currency

wholeValue

number

required

The value, without any float points
Usually how many cents, depending if the currency has cent

cancellationReason

string

The reason given for the cancellation of this payment (if applicable)

virtualPayment

boolean

A payment that is used to calculate fees and withholdings.

status

string

required

CANCELLED COMPLETED CREATING DRAFT FAILED PROCESSING RETURNED SUBMITTED SUBMITTING WAITING_COMPLIANCE WAITING_FUNDING WAITING_PAYABILITY WAITING_RETURN

payee

object

required

userId

string

required

The user id

payorId

string

required

The payor this user is tied to as payee

referenceId

string

required

A unique identifier to cross reference between systems, this unique identifier should reference the user in your system

string

required

The user's email

payable

boolean

required

Flags if this specific payee is able to receive payments

auditInfo

object

required

submittedAt

string

The date and time this payment was submitted

estimateDeliveryAt

string

The date and time this payment is expected to be completed

createdBy

string

User who created this record

updatedBy

string

User who updated this record

updatedAt

date-time

Last update date

createdAt

date-time

Date of creation

isSubmittable

boolean

required

If this payment can be submitted for processing

isAutoSubmittable

boolean

required

If this payment can be submitted for processing automatically at a later time

isEditable

boolean

If this payment can be edited

isAutoSubmitOn

boolean

If this payment is flagged for auto submission

isCancellable

boolean

If this payment can be cancelled

totalPayorFees

number

Total amount in fees payor covered in this payment across all attempts

totalPayeeFees

number

Total amount in fees payee covered in this payment across all attempts

totalFxLosses

number

Total FX difference on this payment across all attempts

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.paymentlabs.io/batches/batchId/payments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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.