POST
/
disputes
{
  "status": "00",
  "message": "The process was completed successfully",
  "data": {
    "report_reference": "DISP1234567890",
    "report_status": "LOGGED",
    "first_response_sla": "24 hours",
    "resolution_sla": "7 days",
    "follow_up_email": "support@example.com",
    "follow_up_phone": "+2348012345678",
    "custom_properties": [
      {
        "id": "1",
        "description": "custom_property",
        "type": "string"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
connection-id
string

Connection ID for the target bank

​
idempotency-key
string
required

Unique key to ensure idempotency of the request

​
signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Body

application/json
​
reference
string
required

The reference for the dispute

Example:

"DISP1234567890"

​
description
string
required

The description of the dispute

Example:

"Dispute description"

​
customer_id
string
required

The customer ID

Example:

"CUS1234567890"

​
dispute_category_id
string
required

The dispute category ID

Example:

"DISP1234567890"

​
amount
number
required

The amount of the dispute

Example:

100

​
custom_properties
object[]

Additional fields for future expansion

Response

Bill payment successful

​
status
string
required
Example:

"00"

​
message
string
required
Example:

"The process was completed successfully"

​
data
object
required
⌘I