transactions

POST /v1/transactions

Request

  • Base URL
    https://apibusiness-staging-civ.djamo.io
  • Auth
    HTTP bearer

Request body

msisdnstring required

The recipient phone number.

amountnumber required

The amount to send to the account

referencestring required

The unique identifier of the transaction on your side.

descriptionstring required

Description for the receiver

type'transfer' required

Type of the transaction

metadataobject

Optional key-value pairs to attach additional information to the transaction.

Example request

{
  "msisdn": "225079932203",
  "amount": 500,
  "reference": "17f9956f-0965-4964-b2c1-40b4fef141a7",
  "description": "July's salary",
  "type": "transfer",
  "metadata": {
    "senderAddress": "1 rue du jour, Abidjan",
    "recipientAddress": "2 rue de la nuit, Abidjan"
  }
}

Response

idstring required

Universal Unique Identifier for the object.

createdAtstring required

Date and time when the object was created. The API returns this value in ISO 8601 format.

updatedAtstring required

Date and time when the object was updated. The API returns this value in ISO 8601 format.

amountinteger required

The amount to transfer.

feenumber required

Fee applied.

totalAmountnumber required

Total amount

status'pending' | 'failed' | 'pending_provider' | 'completed' required

Status of the transaction

msisdnstring required

The recipient phone number.

referencestring required

The unique identifier of the transaction on your side.

failureReasonstring required

The reason why the transaction has failed. Available only for failed transaction.

descriptionstring required

Description for the receiver

type'transfer' required

Transaction type.

batchId'transfer' required

Unique identifier of the batch

metadataobject

Key-value pairs attached to the transaction. null if none was provided.

Example response

{
  "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
  "createdAt": "2020-11-24T17:43:15.970Z",
  "updatedAt": "2020-11-24T17:43:15.970Z",
  "amount": 5000,
  "fee": 50,
  "totalAmount": 50,
  "status": "pending",
  "msisdn": "225079932203",
  "reference": "17f9956f-0965-4964-b2c1-40b4fef141a7",
  "failureReason": "There is no account associated with this number",
  "description": "July's salary",
  "type": "transfer",
  "batchId": "17f9956f-0965-4964-b2c1-40b4fef141a7",
  "metadata": {
    "senderAddress": "1 rue du jour, Abidjan",
    "recipientAddress": "2 rue de la nuit, Abidjan"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.