Collection
Represent Collection Client used for collection product
async create_access_token()
async get_account_balance()
async get_account_balance_in()
async get_basic_user_info()
async ask_user_info()
async request_to_pay()
async get_withdraw_status()
async withdraw()
async isActive()
awaitcreate_access_token( authorization )
awaitcreate_access_token( authorization )Method to create access token for collection user
Parameters :
authorization (str) - a valid basic authentification token
Return
(bool, data)
{
"access_token": "string",
"token_type": "string",
"expires_in": 0
}Return Type :
Tuple
await get_account_balance( authorization, target )
await get_account_balance( authorization, target )Method to get balance for collection user
Parameters :
authorization (str) - A valid bearer authentification token
target (str) - The target environment
Return :
(bool, data)
{
"availableBalance": "string",
"currency": "string"
}Return Type :
Tuple
await get_account_balance_in( currency, authorization, target )
await get_account_balance_in( currency, authorization, target )Method to get balance in specific currency for collection user
Parameters :
currency (str) - A valid ISO4217 Currency
authorization (str) - A valid bearer authentification token
target (str) - The target environment
Return :
(bool, data)
{
"availableBalance": "string",
"currency": "string"
}Return Type :
Tuple
await get_basic_user_info( msisdn, authorization, target )
await get_basic_user_info( msisdn, authorization, target )Method to get basic user info without consent for collection user
Parameters :
msisdn (str) - The number of the user
authorization (str) - A valid bearer authentification token
target (str) - The target environment
Return :
(bool, data)
{
"given_name": "string",
"family_name": "string",
"birthdate": "string",
"locale": "string",
"gender": "string",
"status": "string"
}Return Type:
Tuple
await ask_user_info( authorization, target )
await ask_user_info( authorization, target )Method to get user info with consent for collection user
Parameters :
authorization (str) - A valld bearer authentification token
target (str) - The target environment
Return :
(bool, data)
{
"sub": "string",
"name": "string",
"given_name": "string",
"family_name": "string",
"middle_name": "string",
"email": "string",
"email_verified": true,
"gender": "string",
"locale": "string",
"phone_number": "string",
"phone_number_verified": true,
"address": "string",
"updated_at": 0,
"status": "string",
"birthdate": "string",
"credit_score": "string",
"active": true,
"country_of_birth": "string",
"region_of_birth": "string",
"city_of_birth": "string",
"occupation": "string",
"employer_name": "string",
"identification_type": "string",
"identification_value": "string"
}Return Type :
Tuple
await request_to_pay( authorization, uuid, target, body, callback )
await request_to_pay( authorization, uuid, target, body, callback )Method to request a payment for collection user
Parameters :
authorization (str) - A valid bearer authentification token
uuid (str) - A valid UUID version 4
target (str) - The target environment
body (Dict) - A dictionnary with full detail of the payment [see detail below]
According to MTN MOMO API
{
"amount": "string",
"currency": "string",
"externalId": "string",
"payer": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string"
}{
"type": "object",
"properties": {
"amount": {
"type": "string",
"description": "Amount that will be debited from the payer account."
},
"currency": {
"type": "string",
"description": "ISO4217 Currency"
},
"externalId": {
"type": "string",
"description": "External id is used as a reference to the transaction. External id is used for reconciliation. The external id will be included in transaction history report. <br>External id is not required to be unique."
},
"payer": {
"type": "object",
"properties": {
"partyIdType": {
"enum": [
"MSISDN",
"EMAIL",
"PARTY_CODE"
],
"type": "string"
},
"partyId": {
"type": "string"
}
},
"description": "Party identifies a account holder in the wallet platform. Party consists of two parameters, type and partyId. Each type have its own validation of the partyId<br> MSISDN - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN<br> EMAIL - Validated to be a valid e-mail format. Validated with IsEmail<br> PARTY_CODE - UUID of the party. Validated with IsUuid"
},
"payerMessage": {
"type": "string",
"description": "Message that will be written in the payer transaction history message field."
},
"payeeNote": {
"type": "string",
"description": "Message that will be written in the payee transaction history note field."
}
}
}callback ( Optional[str] ) - The website receiving call back
Return :
(bool, data)
Retrun Type :
Tuple
await get_withdraw_status( authorization, uuid, target )
await get_withdraw_status( authorization, uuid, target )Method to get a withdrawal status for collection user
Parameters :
authorization (str) - A valid bearer authentification token
uuid (str) - A valid UUID version 4
target (str) - The target environment
Return :
(bool, data)
According to MTN MOMO API
{
"amount": "string",
"currency": "string",
"financialTransactionId": "string",
"externalId": "string",
"payer": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string",
"status": "PENDING",
"reason": {
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
}Return Type:
Tuple
await withdraw( authorization, uuid, target, body, callback )
await withdraw( authorization, uuid, target, body, callback )Method to withdraw money for collection user
The library is taking in charge only Withdraw V2
Parameters :
authorization (str) - A valid bearer authentification token
uuid (str) - A valid UUID version 4
target (str) - The target environment
body (Dict) - A dictionnary with full detail of the payment [see detail below]
callback ( Optional[str] ) - The website receiving call back
Return :
(bool, data)
Return Type :
Tuple
await isActive( account, account_type, authorization, target )
await isActive( account, account_type, authorization, target )Method to check if an account is active for a collection user
Parameters :
account (str) - The account target
account_type (str) - Specifies the type of the party ID. Allowed values [msisdn, email, party_code]. default set to msisdn
authorization (str) - A valid bearer authentification token
target (str) - The target environment
Return :
(bool, data)
Return Type :
Tuple
Last updated