neo-pays

Collection accounts

Generated page, from the OpenAPI specification the gateway serves (GET /v1/openapi.json). Do not edit it by hand: it is rewritten on every build.

Method Path Description
POST /v1/collection-accounts Create a virtual IBAN for a partner system's customer
GET /v1/collection-accounts/{ncp}/rib Download the RIB (PDF)
POST /v1/collection-accounts/{ncp}/status Activate or deactivate a virtual IBAN
POST /v1/collection-accounts/{ncp}/holder Update a virtual IBAN's holder

POST /v1/collection-accounts

Create a virtual IBAN for a partner system's customer

Restricted to omnibus SYSTEM CLIENTS (neo-card, neo-tpe). An ordinary merchant has no access to it: their own account is created automatically on KYB approval and is read in the dashboard.

The identities passed here are REQUIRED BY THE BANK in order to open an account. neo-pays passes them on and keeps nothing: no partner-system customer is recorded with us, in any form.

⚠️ Keep the ncp returned: every later operation addresses it, and neo-pays holds no record that would let you find it again.

⚠️ On a 409 ambiguous_create response, DO NOT RETRY: an account may exist at the bank. This API has no idempotency key, and a second attempt would create a second real account.

Responses

  • 201 — Account created
  • 400 — Invalid request
  • 403 — This client is not an omnibus system client
  • 409 — Outcome UNKNOWN — do not retry
  • 503 — The bank is unreachable

GET /v1/collection-accounts/{ncp}/rib

Download the RIB (PDF)

Parameters

Name In Required Description
ncp path yes The account number returned at creation.

Responses

  • 200 — The PDF, as-is
  • 403 — This account belongs to a neo-pays merchant
  • 503 — The bank is unreachable

POST /v1/collection-accounts/{ncp}/status

Activate or deactivate a virtual IBAN

⚠️ This is the REAL switch, and it acts AT THE BANK: a deactivated account can no longer RECEIVE transfers. No flag at neo-pays has that effect.

Parameters

Name In Required Description
ncp path yes

Responses

  • 200 — Applied
  • 400 — "enabled" missing or invalid
  • 403 — This account belongs to a neo-pays merchant
  • 503 — The bank is unreachable

POST /v1/collection-accounts/{ncp}/holder

Update a virtual IBAN's holder

Changes the name and address the bank holds for this account (Eucalyptus §9). The account number and the IBAN are unchanged.

⚠️ SEND THE COMPLETE HOLDER, not only the fields that changed. The specification marks every field optional and nowhere says what becomes of an OMITTED one: “left unchanged” and “set to empty” are both consistent with the text, and the difference is that an address-only change might wipe the name on a bank record. Read the current values back and resend them alongside what changes.

Parameters

Name In Required Description
ncp path yes

Responses

  • 200 — Applied
  • 400 — name missing
  • 403 — This account belongs to a neo-pays merchant
  • 503 — The bank is unreachable