Declares that a customer will pay amount in currency from their IBAN before expiresAt. Name the payer in customer, in one of two forms: written out (customerReference, fullName, iban, optional swiftCode; the customer for that IBAN and currency is found, created or bound to your reference) or by id (customerId, with an optional customerReference; the saved customer's own name, IBAN and reference are used).
The incoming payment is credited exactly as it always was, matched to this declaration, and reported on transaction.incoming (matchStatus, depositId, customer). A payment with no declaration is credited and reported unmatched.
Needs the create Deposit permission (403 ABILITY_DENIED without it, checked before the body is validated). A scoped credential's grant can be limited by currency and amountMax only (403 CONDITION_FAILED outside it).
Processed in this order: permission; shape (for a customer written out, the reference and IBAN); the credential's currency and amount limits; idempotency (an identical repeat returns the original); expiry window; then, written out, whether the key may send a customer reference at all (403 FIELD_EXCLUDED) and the customer is resolved and bound (409 CUSTOMER_REFERENCE_CONFLICT when it is bound to another reference); by id, the key's access to the customer (403 CONDITION_FAILED, or 403 FIELD_EXCLUDED when the key cannot read its iban or customerReference) and what the customer holds, then the reference is applied the same way. The declaration is stored open. A refused declaration leaves no customer, binding or declaration behind. A declaration is never refused because its name differs from the name saved on an existing customer.
By id: the customer must be on the swift rail with a valid IBAN that is not one of Enovipay's own (400 VALIDATION_ERROR), hold a currency (400 CUSTOMER_INCOMPLETE) equal to the declaration's, compared in any letter case (400 CUSTOMER_CURRENCY_MISMATCH), and have a name (400 CUSTOMER_INCOMPLETE). Send no reference and the customer's own is used; a customer with none is 400 CUSTOMER_UNBOUND. A reference sent binds an unbound customer and must equal a bound customer's (409 CUSTOMER_REFERENCE_CONFLICT). An unknown, deleted or other merchant's customer is 404; a merged id leads to the surviving customer.
idempotencyKey is required and scoped to the merchant. The same key with identical content returns the original with 200; with different content, 409 IDEMPOTENCY_KEY_REUSED. A key used in one form and repeated in the other is different content.
Rate limit: 120 / minute per client IP, in a tier of its own.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
