createClaimlessPayment

post https://sandbox-api.veem.com/veem/v1.2/claimless-payments

Creates a pay direct payment to the payee's (receiver's) bank account

Responses

Response body

object

amount

object

required

currency

string

AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BOV BRL BSD BTN BWP BYN BYR BZD CAD CDF CHE CHF CHW CLF CLP CNY COP COU CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB EUR FJD FKP GBP GEL GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS INR IQD IRR ISK JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LYD MAD MDL MGA MKD MMK MNT MOP MRO MRU MUR MVR MWK MXN MXV MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RUR RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD SSP STD STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX USD USN USS UYI UYU UZS VEF VND VUV WST XAF XAG XAU XBA XBB XBC XBD XCD XDR XOF XPD XPF XPT XSU XTS XUA XXX YER ZAR ZMW ZWL

number

attachments

array of objects

The list of external invoices to be attached with payment. The files can be uploaded usingfile upload apis

attachments

object

name

string

required

The name of the file (including the extension)

referenceId

string

required

The file reference id received from Veem after file upload is complete

type

string

required

The type of the file

ExternalInvoice ProofOfPayment

batchItemId

int64

required

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

bruid

string

FX rates BRUID

ccEmails

array of strings

The list of emails who will be notified about the payment

ccEmails

claimLink

string

The link that allows the recipient to claim the payment

clientId

string

debitCreditTxn

object

Debit and credit txn

dueDate

date-time

The due date of the payment or invoice request

exchangeRate

object

required

expiry

date-time

required

The expiry time of the current rate quote

fromAmount

number

The source amount, either from or to amount is allowed, the other one is calculated

fromCurrency

string

required

The source currency

string

required

The quote id

rate

number

required

The Veem exchange rate for current transfer

timeCreated

date-time

required

The quote generation time

toAmount

number

required

The target amount, either from or to amount is allowed, the other one is calculated

toCurrency

string

required

The target currency

exchangeRateQuoteId

string

required

The quote id that was received earlier for the payment

externalInvoiceRefId

string

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

feeInformation

object

payeeInfo

object

payerInfo

object

fundingMethod

object

int64

required

The payer's funding method id. This comes from the funding methods service.

type

string

required

The payer's funding method type. Can be one of: Bank, Card or Wallet.

Bank External Cheque Card Wallet VirtualCard

goodFundsPayment

boolean

int64

required

The payment id

invoiceId

int64

required

The invoice id this payment originated from

notes

string

The memo/note associated with payment, viewable by receiver

payee

object

required

bank

object

required

Get required bank fields by looking up the country from the meta-controller endpoint country-currency-map with bankFields=true

Has additional fields

business

object

required

businessName

string

required

The name of the receiver's business, required when account type is business

countryCode

string

required

The 2 letter ISO country codes,ISO Alpha-2

AC AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BU BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CP CR CS CU CV CW CX CY CZ DE DG DJ DK DM DO DZ EA EC EE EG EH ER ES ET EU EZ FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU IC ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NT NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SF SG SH SI SJ SK SL SM SN SO SR SS ST SU SV SX SY SZ TA TC TD TF TG TH TJ TK TL TM TN TO TP TR TT TV TW TZ UA UG UK UM US UY UZ VA VC VE VG VI VN VU WF WS XK YE YT YU ZA ZM ZR ZW

string

required

The email of the receiver

firstName

string

required

The first name of the receiver

lastName

string

required

The last name of the receiver

type

string

required

The type of the receiver

Incomplete Business Personal

payeeAmount

object

currency

string

number

payeeFundingMethod

object

int64

required

The payer's funding method id. This comes from the funding methods service.

type

string

required

The payer's funding method type. Can be one of: Bank, Card or Wallet.

Bank External Cheque Card Wallet VirtualCard

paymentAction

string

SubmitForApproval Approve

paymentApproval

object

approvalStatus

string

Approved Pending Ignored

approverNumber

int32

approverNumberRequired

int32

userApprovalList

array of objects

userApprovalList

object

approvalStatus

string

Approved Pending Ignored

string

firstName

string

lastName

string

middleName

string

paymentApprovalRequest

object

accountId

int64

userId

int64

paymentAttributes

object

type

array of strings

type

paymentMethod

string

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

Bank External Cheque Card Wallet VirtualCard

purposeOfPayment

string

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

purposeOfPaymentDescription

string

The purpose of payment description

pushPaymentInfo

object

accountBsb

string

accountNumber

string

amount

object

bankAccountNumber

string

bankAddress

string

bankName

string

bankRoutingNumber

string

beneficiaryAccountName

string

beneficiaryCountry

string

iban

string

reference

string

sortCode

string

swiftOrBicCode

string

status

string

required

The status of the payment

Drafted Sent Claimed PendingAuth PendingApproval Authorized InProgress Complete Cancelled Closed Reversed Scheduled SchedulingInProgress

timeCreated

string

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

timeUpdated

string

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

validationErrorMessage

string

Error message to be returned when the request is not valid

Response body

object

amount

object

required

currency

string

number

attachments

array of objects

The list of external invoices to be attached with payment. The files can be uploaded usingfile upload apis

attachments

object

name

string

required

The name of the file (including the extension)

referenceId

string

required

The file reference id received from Veem after file upload is complete

type

string

required

The type of the file

ExternalInvoice ProofOfPayment

batchItemId

int64

required

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

bruid

string

FX rates BRUID

ccEmails

array of strings

The list of emails who will be notified about the payment

ccEmails

claimLink

string

The link that allows the recipient to claim the payment

clientId

string

debitCreditTxn

object

Debit and credit txn

dueDate

date-time

The due date of the payment or invoice request

exchangeRate

object

required

expiry

date-time

required

The expiry time of the current rate quote

fromAmount

number

The source amount, either from or to amount is allowed, the other one is calculated

fromCurrency

string

required

The source currency

string

required

The quote id

rate

number

required

The Veem exchange rate for current transfer

timeCreated

date-time

required

The quote generation time

toAmount

number

required

The target amount, either from or to amount is allowed, the other one is calculated

toCurrency

string

required

The target currency

exchangeRateQuoteId

string

required

The quote id that was received earlier for the payment

externalInvoiceRefId

string

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

feeInformation

object

payeeInfo

object

payerInfo

object

fundingMethod

object

int64

required

The payer's funding method id. This comes from the funding methods service.

type

string

required

The payer's funding method type. Can be one of: Bank, Card or Wallet.

Bank External Cheque Card Wallet VirtualCard

goodFundsPayment

boolean

int64

required

The payment id

invoiceId

int64

required

The invoice id this payment originated from

notes

string

The memo/note associated with payment, viewable by receiver

payee

object

required

bank

object

required

Get required bank fields by looking up the country from the meta-controller endpoint country-currency-map with bankFields=true

Has additional fields

business

object

required

businessName

string

required

The name of the receiver's business, required when account type is business

countryCode

string

required

The 2 letter ISO country codes,ISO Alpha-2

string

required

The email of the receiver

firstName

string

required

The first name of the receiver

lastName

string

required

The last name of the receiver

type

string

required

The type of the receiver

Incomplete Business Personal

payeeAmount

object

currency

string

number

payeeFundingMethod

object

int64

required

The payer's funding method id. This comes from the funding methods service.

type

string

required

The payer's funding method type. Can be one of: Bank, Card or Wallet.

Bank External Cheque Card Wallet VirtualCard

paymentAction

string

SubmitForApproval Approve

paymentApproval

object

approvalStatus

string

Approved Pending Ignored

approverNumber

int32

approverNumberRequired

int32

userApprovalList

array of objects

userApprovalList

object

approvalStatus

string

Approved Pending Ignored

string

firstName

string

lastName

string

middleName

string

paymentApprovalRequest

object

accountId

int64

userId

int64

paymentAttributes

object

type

array of strings

type

paymentMethod

string

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

Bank External Cheque Card Wallet VirtualCard

purposeOfPayment

string

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

purposeOfPaymentDescription

string

The purpose of payment description

pushPaymentInfo

object

accountBsb

string

accountNumber

string

amount

object

bankAccountNumber

string

bankAddress

string

bankName

string

bankRoutingNumber

string

beneficiaryAccountName

string

beneficiaryCountry

string

iban

string

reference

string

sortCode

string

swiftOrBicCode

string

status

string

required

The status of the payment

Drafted Sent Claimed PendingAuth PendingApproval Authorized InProgress Complete Cancelled Closed Reversed Scheduled SchedulingInProgress

timeCreated

string

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

timeUpdated

string

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

validationErrorMessage

string

Error message to be returned when the request is not valid

401

Unauthorized, the token is invalid or expired

403

Forbidden, the token owner doesn't have permission to operate current API

404

Not Found, the resource not found

500

Internal Server Error, see the error code and API doc for reference

Language


xxxxxxxxxx
20
1
curl --request POST \
2
     --url https://sandbox-api.veem.com/veem/v1.2/claimless-payments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "fundingMethod": {
8
    "type": "Bank"
9
  },
10
  "payee": {
11
    "business": {
12
      "address": {
13
        "countryCode": "AC"
14
      }
15
    },
16
    "countryCode": "AC",
17
    "type": "Incomplete"
18
  }
19
}
20
'

Choose an example:

application/json

200Success, a payment is created in Veem

201Created

400Unauthorized, the token is invalid or expired