Create a new adhoc invoice payment

post/adhoc-invoice-payments
SecuritybearerAuth
Request
Request Body schema: application/json

New invoice payment

generatedAdhocInvoiceId
required
integer <int64>

Generated Adhoc Invoice identifier

thirdPartyPaymentStatus
string (ThirdPartyPaymentStatus)

Invoice payment status. Not applicable for manual payments

Enum: "NEW" "CREATED" "PENDING_CUSTOMER_APPROVAL" "PENDING_SUBMISSION" "SUBMITTED" "CONFIRMED" "PAID_OUT" "CANCELLED" "FAILED" "FAILED_RETRYING" "CHARGED_BACK" "CUSTOMER_APPROVAL_GRANTED" "CUSTOMER_APPROVAL_DENIED" "CHARGEBACK_CANCELLED" "LATE_FAILURE_SETTLED" "CHARGEBACK_SETTLED" "SURCHARGE_FEE_DEBITED" "RESUBMISSION_REQUESTED" "UNSUPPORTED_PAYMENT_TYPE" "UNAUTHORISED_PAYMENT_TYPE" "CUSTOMER_APPROVAL_MISSING" "SURCHARGE_FEE_CREDITED" "MANUALLY_PAID" "UNSENT" "REFUNDED" "PARTIALLY_REFUNDED" "REFUND_PENDING"
amountInMajorCurrency
required
number [ -100000 .. 100000 ]

Amount in major currency (e.g pounds/dollars/euros)

description
required
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Payment description

paymentMethod
required
string (PaymentMethod)

Payment method

Enum: "CHEQUE" "DIRECT_DEBIT" "CANCELLED_DD" "CREDIT_CARD" "PAYPAL" "BACS" "POST_OFFICE_PAYMENT_CARD" "EZYPAY" "GO_CARDLESS" "GC_INSTANT_BANK_PAYMENTS" "STRIPE" "FINASTRA" "FAST_PAY" "OTHER"
Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "generatedAdhocInvoiceId": 1,
  • "thirdPartyPaymentStatus": "NEW",
  • "amountInMajorCurrency": 10.5,
  • "description": "string",
  • "paymentMethod": "CHEQUE"
}
Response samples
application/json
{
  • "id": 1,
  • "generatedAdhocInvoiceId": 1,
  • "thirdPartyPaymentStatus": "NEW",
  • "amountInMajorCurrency": 10.5,
  • "currencyId": 1,
  • "description": "string",
  • "metaData": "string",
  • "errorInfo": "string",
  • "paymentMethod": "CHEQUE",
  • "paymentDate": "2019-08-24",
  • "customerPaymentType": "CUSTOMER",
  • "customerPaymentId": 1
}