Developers
API referenceBusiness sign in

Schema

PaymentIntent

An object of the Qoene Delivery API.

Fields

PaymentIntent fields
FieldTypeDescription
public_idRequiredstringLIVE QDMPI or QD-MPI-. TEST QDTPI or QD-TPI-.Pattern ^(?:QD-MPI-[A-F0-9]{24}|QDMPI[A-Z0-9]{3,31}|QD-TPI-[A-F0-9]{24}|QDTPI[A-Z0-9]{3,31})$
shipment_idRequiredstringLIVE shipments use QDSHP or QD-SHP-. TEST shipments use QDTST or QD-TST-.Pattern ^(?:QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31}|QD-TST-[A-F0-9]{24}|QDTST[A-Z0-9]{3,31})$
obligation_idOptionalstring
amount_minorRequiredMinorAmountMoney in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer.
paid_minorOptionalMinorAmountMoney in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer.
refunded_minorOptionalMinorAmountMoney in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer.
net_paid_minorOptionalMinorAmountMoney in integer pesewas (GHS minor units). 64-bit columns are returned as a decimal string; treat both forms as an integer.
currencyOptionalstring
statusRequiredenumPENDING and RECONCILIATION_REQUIRED do not mean paid.One of REQUIRES_APPROVAL, PENDING, RECONCILIATION_REQUIRED, PAID, CANCELLED, SIMULATED
latest_attemptOptionalobject or null
idOptionalstring
providerOptionalstring
statusOptionalstring
approval_urlOptionalstring or nullSend to an authorized Business member, never to the receiver.
created_atOptionalstring (date-time)
simulatedRequiredboolean

Used by