Sign in

v1

latestOpenAPI 3.0.02026-07-245095152.4 KB
payment-controller

getPayment

get payment details

get/veem/v1.2/payments/{paymentId}

Path parameters

paymentIdinteger required

paymentId

Response

Success, a payment object is returned

batchItemIdinteger required

The payment's batchItemId, as specified in the payment creation batch

bruidstring

FX rates BRUID

ccEmailsstring[]

The list of emails who will be notified about the payment

claimLinkstring

The link that allows the recipient to claim the payment

clientIdstring
dueDatestring date-time

The due date of the payment or invoice request

exchangeRateQuoteIdstring required

The quote id that was received earlier for the payment

externalInvoiceRefIdstring

The external invoice if for which payment is made, viewable by receiver

goodFundsPaymentboolean
idinteger required

The payment id

invoiceIdinteger required

The invoice id this payment originated from

notesstring

The memo/note associated with payment, viewable by receiver

paymentAction'SubmitForApproval' | 'Approve'
paymentMethod'Bank' | 'External' | 'Cheque' | 'Card' | 'Wallet' | 'VirtualCard'

The payer's funding method type. Can be one of: Bank, Card or Wallet. Deprecated please use amount instead

purposeOfPaymentstring

The purpose of payment required by banks for certain countries, applicable for following countries.SG,AE,KR,BR,CN,HK,HR,IS,ID,IN,IL,KE,PK,SA,ZA,TW,UA,VN

purposeOfPaymentDescriptionstring

The purpose of payment description

status'Drafted' | 'Sent' | 'Claimed' | 'PendingAuth' | 'PendingApproval' | 'Authorized' | 'InProgress' | 'Complete' | 'Cancelled' | 'Closed' | 'Reversed' | 'Scheduled' | 'SchedulingInProgress' required

The status of the payment

timeCreatedstring

The creation time of the payment. The format is ISO-8601.

timeUpdatedstring

The most recent update time of the payment. The format is ISO-8601.

validationErrorMessagestring

Error message to be returned when the request is not valid