Skip to main content
POST
/
api
/
agent
/
bills
/
v3
Collect payment (Pay-In)
curl --request POST \
  --url https://sandbox.soleaspay.com/api/agent/bills/v3 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'operation: <operation>' \
  --header 'service: <service>' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "wallet": "690000001",
  "amount": 1000,
  "currency": "XAF",
  "order_id": "abc1234",
  "description": "pay for rent",
  "payer": "John",
  "payerEmail": "[email protected]",
  "successUrl": "https://successurl.com/receive-payment",
  "failureUrl": "https://failureurl.com/payment-fail"
}
'
{
  "success": true,
  "code": 200,
  "status": "PROCESSING",
  "created_at": "2024-12-16 10:05:01",
  "data": {
    "operation": "PURCHASE",
    "reference": "MLS2021B",
    "external_reference": "abc1234",
    "transaction_reference": "<unknown>",
    "transaction_category": "direct",
    "transaction_channel": "MSISDN",
    "amount": "1000",
    "currency": "XAF"
  },
  "message": "transaction processing"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-key
string
required

Your API key

​
operation
integer
required

Operation code. For this endpoint, must be 2

Example:

2

​
service
integer
required

The service your customer will pay for

Example:

2

​
otp
integer

For Orange Money service, provide OTP code if required by your logic

Body

application/json
​
wallet
string
required

The wallet where we proceed the payment

Example:

"690000001"

​
amount
number<float>
required

Amount of current payment

Example:

1000

​
currency
string
required

Currency in which the payment is processed

Example:

"XAF"

​
order_id
string
required

Unique order ID in your app for the current payment

Example:

"abc1234"

​
description
string
required

Short description of the current payment

Example:

"pay for rent"

​
payer
string
required

Name of your customer

Example:

"John"

​
payerEmail
string<email>
required

Customer email to receive payment receipt after confirmation

Example:

"[email protected]"

​
successUrl
string<uri>
required

URL to notify when payment succeeds

Example:

"https://successurl.com/receive-payment"

​
failureUrl
string<uri>
required

URL to notify when payment fails

Example:

"https://failureurl.com/payment-fail"

Response

Success request - Transaction is processing

​
success
boolean
Example:

true

​
code
integer
Example:

200

​
status
string
Example:

"PROCESSING"

​
created_at
string
Example:

"2024-12-16 10:05:01"

​
data
object
​
message
string
Example:

"transaction processing"