Affinity API 1.0 Help

Making a deposit

Accounts can be funded via any of the two supported digital channels

1. GHIPSS

We are integrated with the Ghana Interbank Payment and Settlement Systems (GhIPSS), which means all accounts are accessible via the GhIPSS Instant Pay (GIP) platform

2. Via 3rd-party partners

Certain partners may utilize their own integrations with mobile money networks and banks to deposit funds on behalf of customers, under special arrangements coordinated with Affinity

To register as a partner, please visit our developer portal to get started

Making the request

Name

Type

Description

Notes

1.

accountNumber

string

Account number of the customer to be credited

[required]

2.

amount

number

Amount to be deposited

[required]

3.

transactionReference

string

A unique reference for the transaction

[required]

4.

customerReference

string

A custom identifier assigned by the partner to track or associate transactions with a specific customer

[optional]

5.

paymentChannel

string

Specifies the channel used to collect funds from the customer. Valid values are: BANK, MOBILE_MONEY.

[optional]

6.

currency

string

Currency – All amounts are displayed in GHS by default

[optional]

7.

idempotencyKey

string (uuid)

Idempotency keys are unique keys that identify each request to prevent duplication regardless of the number of times it was submitted

[required]

{ "method": "post", "url": "https://open-orion.affnty.co/api/v1/transactions/deposit", "headers": { "Content-Type": "application/json", "X-API-KEY":"" }, "body": { "accountNumber":"1234568650", "amount":100.53, "transactionReference":"46a1f1221999", "paymentChannel":"MOBILE_MONEY", "idempotencyKey": "7856a878-b513-4c89-ac2d-c46a1f103523" } }
properties: reference: type: string status: type: string enum: - PROCESSING - FAILED - SUCCESS statusCode: type: string createdAt: type: string updatedAt: type: string currency: type: string amount: type: string fee: type: string note: type: string seviceType: type: string enum: - DEPOSIT - TRANSFER

Sample Response

{ "reference": "46a1f1221999", "status": "FAILED", "statusCode": "01", "createdAt": "2023-04-16T13:35:58.698646200", "updatedAt": "2023-04-16T13:35:58.698646200", "currency": null, "amount": "100.53", "fee": "0", "note": null }
Last modified: 27 August 2025