Top Up Wallet | CargoExtra Global Logistics USA

Credits wallet after a supported external payment gateway transaction.

Required body fields: amount, paymentGateway, currency. Conditional: reference required for Paystack; paymentIntentId required for Stripe; paymentId required for PayPal. currency is code such as NGN, USD, GBP.

Response fields: message, transactionId, amount, walletBalance.

Possible errors:

400: Invalid amount - amount is missing, non-numeric, or less than 1.
404: User not found - authenticated customer was not found downstream.
404: Currency not found - supplied currency code is unknown.
400: Payment method is disabled - selected gateway is not active for the currency.
400: This transaction cannot be completed - duplicate reference/payment id detected.
400: Reference is required - Paystack top-up requires reference.
400: Payment Intent is required - Stripe top-up requires paymentIntentId.
400: Payment Id is required - PayPal top-up requires paymentId.
400: Missing One or More Required Parameters - required body/query fields were not supplied.
401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
403: Access denied - gateway traffic guard/rate policy blocked the request.
429: Too many requests - gateway rate limit exceeded.
500: Unexpected Error - unhandled gateway or downstream service failure.

Credits wallet after a supported external payment gateway transaction. Required body fields: `amount`, `paymentGateway`, `currency`. Conditional: `reference` required for Paystack; `paymentIntentId` required for Stripe; `paymentId` required for PayPal. `currency` is code such as `NGN`, `USD`, `GBP`. Response fields: `message`, `transactionId`, `amount`, `walletBalance`. Possible errors: - 400: Invalid amount - amount is missing, non-numeric, or less than 1. - 404: User not found - authenticated customer was not found downstream. - 404: Currency not found - supplied currency code is unknown. - 400: Payment method is disabled - selected gateway is not active for the currency. - 400: This transaction cannot be completed - duplicate reference/payment id detected. - 400: Reference is required - Paystack top-up requires `reference`. - 400: Payment Intent is required - Stripe top-up requires `paymentIntentId`. - 400: Payment Id is required - PayPal top-up requires `paymentId`. - 400: Missing One or More Required Parameters - required body/query fields were not supplied. - 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found. - 403: Access denied - gateway traffic guard/rate policy blocked the request. - 429: Too many requests - gateway rate limit exceeded. - 500: Unexpected Error - unhandled gateway or downstream service failure.

Request

This endpoint expects an object.

amountintegerRequired

currencystringRequired

paymentIdstringRequired

referencestringRequired

paymentGatewaystringRequired

paymentIntentIdstringRequired

Response

key_0integer

key_1string

key_2double

key_3string

key_4boolean

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Credits wallet after a supported external payment gateway transaction.

Response fields: message, transactionId, amount, walletBalance.

Possible errors:

400: Invalid amount - amount is missing, non-numeric, or less than 1.
404: User not found - authenticated customer was not found downstream.
404: Currency not found - supplied currency code is unknown.
400: Payment method is disabled - selected gateway is not active for the currency.
400: This transaction cannot be completed - duplicate reference/payment id detected.
400: Reference is required - Paystack top-up requires reference.
400: Payment Intent is required - Stripe top-up requires paymentIntentId.
400: Payment Id is required - PayPal top-up requires paymentId.
400: Missing One or More Required Parameters - required body/query fields were not supplied.
401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
403: Access denied - gateway traffic guard/rate policy blocked the request.
429: Too many requests - gateway rate limit exceeded.
500: Unexpected Error - unhandled gateway or downstream service failure.

$	curl -X POST http://localhost:9000/api/v1/billing/wallet/topup \
>	-H "Content-Type: application/json" \
>	-d '{
>	"amount": 5000,
>	"currency": "NGN",
>	"paymentId": "",
>	"reference": "PAYSTACK_REF_20240615_001",
>	"paymentGateway": "Paystack",
>	"paymentIntentId": ""
>	}'

1	{
2	"key_0": 987654,
3	"key_1": "TXN20240615NGN987654",
4	"key_2": 5000,
5	"key_3": "Wallet credited successfully",
6	"key_4": true
7	}