API

Initiate making a payment by an organisation

post
https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants//organisations//payments

The first step for an organisation to make a payment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
int64
required
Body Params
additionalFields
array of objects

Additional fields captured by the organisation be submitted for processing. These fields relate to additionalFields requested when the payment was initiated or in the VAS catalog

additionalFields
additionalMerchantData
object
number
≥ 0

The amount for the payment. Optional depending on the payment type. Amounts are in major currency unit

string
length between 10 and 2000

The URL Eclipse must post the PaymentResult to. Optional as one can always do a GET to get the result instead of using callbacks. This will be a system-system call

string

Optional. Card on file id for pre-enrolled cards to use for the payment if applicable. Negates the need to provide actual card data E.g. PAN etc

string
length between 3 and 3

The currency of the payment amount - e.g. USD, ZAR, NGN, TSH. Must be provided if the amount is provided. Otherwise do not provide

boolean

By default this value is false. If User wants to enable fraud rule checks then need to pass true

string
length between 0 and 200

A description for the payment if being initiated from Eclipse

int64

Used to indicate where the funds must be paid to for payment types GLOBAL_PAYMENT_LINK, GLOBAL_REUSABLE_PAYMENT_LINK, GLOBAL_TOG, GLOBAL_TOG_VAC, GLOBAL_WALLET, KE_DTB_AIRTEL_PROMPT, KE_DTB_MPESA_PROMPT, KE_DTB_STK_PUSH, ZA_HALO, ZA_OZOW, ZA_PNP_CASH

encryptedPaymentCardData
object

If the payment mechanism uses a card and its not a card on file (i.e. cardOnFileId not provided) and PaymentCardData is not provided then this field provides the encrypted card data to use for the payment. supported type(GooglePay)

date-time

When the payment must complete by. If not in final state before this time, Eclipse will timeout the payment

string
required
length between 6 and 100

Provide a GUID for the payment to prevent replays/duplicates

string

Optional. If the payment mechanism is via some proprietary (non-card based) interface such as an external wallet or bank account then this field can be used to identity the payers wallet id, account number, profile id etc.

string

Optional. If the payment mechanism is via some proprietary (non-card based) interface such as an external wallet or bank account then this field can be used to identify what wallet type this is.

string
length between 10 and 2000

Where the organisations iFrame/Browser should be navigated to after the payment has completed (applicable to payments that use 3DS). If the URL contains <paymentId> then <paymentId> will be replaced with the paymentId before the redirect.

string
length between 0 and 200

Optional. Any location information to add to the payment such as GPS coordinates or branch name etc

number

This field specifies the maximum amount to make the partial payment

number

This field specifies the minimum amount to make the partial payment

string
length between 0 and 200

Optional. User defined extra note related to payment in any format free text or JSON formatted text.

paymentCardData
object

If the payment mechanism uses a card and its not a card on file (i.e. cardOnFileId not provided) then this field provides the card data to use for the payment

string

Loosely typed data about the payment. Depends on the payment type. E.g. could be a QRCode or a VAS partnerId, productId combination (For VAS the paymentData must consist of the partnerId and productId of a product in the VAS catalog separated with an _ e.g. 2_ABC123)

string
enum

The mechanism with which to make the payment. Determines if paymentCardData, paymentSecurity data etc are required. If not passed then the requests data like walletId, paymentCardData, paymentSecurityData etc will be used to work out the inferred mechanism

Allowed:
paymentSecurityData
object

Security data related to the payment in order to prove that the payer has authorised the transaction or that the issuer authorises the transaction on behalf of the payer (and hence accepts liability for the payment). Not required if COMPLETION_URL is used as the payment mechanism as the security data will be generated by Eclipse in concert with the issuing bank via an iFrame with the card holder

paymentTerminalData
object

Data about the terminal acquiring the payment

string
boolean

Optional. If the payment mechanism is to pay with a card and card details are provided then this indicates whether to store the card on file

string

Optional. If provided then card ui will be rendered based on the provided templateId else fallback to default tenant template.

string
enum
required

The type of payment being done

boolean

Optional. Indicates that the organisation is not present for the payment and interactive authentication must not happen (e.g. 3DS)

int64

Optional. If the payment mechanism is via an Eclipse wallet, then the Eclipse walletId can be provided in this field

Responses

400

Bad Request

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago