Simulate a final sandbox collection or payout outcome
Requires sandbox:simulate and a sandbox API key. SUCCESS posts the entry; FAILED reverses it and releases payout funds. Repeating an outcome is safe; changing a terminal outcome returns 409. No real money moves.
Requires sandbox:simulate and a sandbox API key. SUCCESS posts the entry; FAILED reverses it and releases payout funds. Repeating an outcome is safe; changing a terminal outcome returns 409. No real money moves.
api-keyx-api-key<token>Your API key: ck_test_... for test mode, ck_live_... for live. Send it with x-api-secret (or Authorization: Bearer ).
id*stringPending sandbox transaction ID to finalize.
x-api-secret?stringRecommended: API secret sent over HTTPS. You may send it as Authorization: Bearer instead. If supplied, x-timestamp and x-signature are not required.
x-timestamp?stringLegacy signed mode: Unix time in milliseconds; maximum clock skew five minutes.
x-signature?stringLegacy signed mode: HMAC-SHA256(secret, timestamp.METHOD.url.idempotencyKey.bodyHash).
x-idempotency-key*string1–128 letters/digits or ._:-. Same key and payload replay for 24 hours; conflicting, in-flight, or expired keys return 409. Never change a key to retry an uncertain payment.
application/json- body
status*string"SUCCESS""FAILED"application/json- response
id*stringtransactionId*stringUse this ID for transaction lookup and sandbox completion. Payout id is a separate payout record ID.
reference*stringstatus*string"PENDING""PROCESSING""SUCCESS""FAILED"amountMinor*stringInteger minor units, encoded as a string.
currency*stringprovider*stringproviderReference*string|nullrequiresReconciliation*booleanTrue when provider outcome is uncertain. Do not retry with a new key; query the transaction or reconcile it.
feeMinor*stringCreddot fee charged to the business in minor units.
totalDebitMinor*stringWallet debit for payouts; equals amountMinor for incoming transfers.
netCreditMinor*stringWallet credit for incoming transfers; equals amountMinor for payouts.
type*string"COLLECTION""PAYOUT""REFUND""REVERSAL""BILL_PAYMENT"environment*string"SANDBOX""LIVE"payoutId*string|nullpaymentUrl*|uridirection*string"MONEY_IN""MONEY_OUT"channel*string|nullcustomerName*string|nullcustomerEmail*|emailproviderFeeMinor*stringUpstream provider fee in minor units.
feeMethod*string|nullfeeRuleId*string|nullsender*sessionId*|NIBSS/Paga session identifier when supplied by the provider.
settlement*payout*|nullbillPayment*|nullledgerEntries*array<>createdAt*stringdate-timeupdatedAt*stringdate-timecurl -X POST 'https://api.creddot.com/api/v1/sandbox/transactions/string/complete' \ -H 'x-idempotency-key: string' \ -H 'Content-Type: application/json' \ -d '{ "status": "SUCCESS"}'{ "id": "string", "transactionId": "string", "reference": "string", "status": "PENDING", "amountMinor": "100000", "currency": "NGN", "provider": "PAGA", "providerReference": "string", "requiresReconciliation": true, "feeMinor": "1500", "totalDebitMinor": "101500", "netCreditMinor": "98500", "type": "COLLECTION", "environment": "SANDBOX", "payoutId": "string", "paymentUrl": "http://example.com", "direction": "MONEY_IN", "channel": "BANK_TRANSFER", "customerName": "string", "customerEmail": "user@example.com", "providerFeeMinor": "5375", "feeMethod": "string", "feeRuleId": "string", "sender": { "name": "string", "bankName": "string", "accountNumberMasked": "string" }, "sessionId": "string", "settlement": { "status": "string", "reference": "string", "settledAt": "2019-08-24T14:15:22Z" }, "payout": {}, "billPayment": {}, "ledgerEntries": [ {} ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Read wallet balances GET
Requires wallets:read. Pending is unconfirmed collection money; reserved is money held for payouts; only available can be spent.
List dedicated collection accounts GET
Requires virtual-accounts:read. Results are scoped to the API key environment. Provision accounts through the Business owner/admin API.