Outbound Payment Import Entry
Import Entries are the individual rows of an outbound payment import, representing each payment to be created.
List outbound payment import entries#
/outbound_payment_import_entriesReturns a cursor-paginated list of the entries for a given outbound payment import.
Response 200
Successful response
outbound_payment_import_entriesarray10 properties
idstring
Unique identifier, beginning with "IE".
created_atstring
Fixed timestamp, recording when this resource was created.
processed_atstring
Fixed timestamp, recording when this entry was processed.
amountinteger
Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
schemestring
Bank payment scheme to process the outbound payment. Currently only "faster_payments" (GBP) is supported.
faster_paymentsreferencestring
An optional reference for the outbound payment.
verification_resultstring
The result of bank account holder verification, if performed.
full_matchpartial_matchno_matchunable_to_matchvalidation_errorsobject
Per-field validation errors for this entry, keyed by resource type and then by field name.
1 properties
outbound_paymentobject
Validation errors for the outbound payment fields.
4 properties
amountarray
Errors related to the amount field.
schemestring
Bank payment scheme to process the outbound payment. Currently only "faster_payments" (GBP) is supported.
faster_paymentsrecipient_bank_accountarray
Errors related to the recipient bank account.
referencearray
Errors related to the reference field.
linksobject
3 properties
outbound_payment_importstring
ID of the associated import.
outbound_paymentstring
ID of the associated outbound payment, once the entry has been processed.
recipient_bank_accountstring
ID of the recipient bank account.
metadataobject
Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
metaobject2 properties
limitintegercursorsobject
2 properties
beforestring
Cursor pointing to the end of the desired set.
afterstring
Cursor pointing to the start of the desired set.
Errors 400401404422500
Bad Request
Unauthorised
Not found
Validation Error
Internal Error
Error Body
codeintegerdocumentation_urlstringerrorsarray2 properties
reasonstringmessagestringmessagestringrequest_idstringtypestringmetadataobjectlinksobject