Skip to main content

Add Payer

This is Company or an Individual who is sending money to the Virtual receiving accounts, which the client needs to add in the system before they start accepting payments from them.

Definition​

URL
POST https://api-test.instarem.com:4803/api/v1/client/{clientId}/payer

Header Parameters:​

ParameterDescriptionTypeRequired
authorizationAuthentication token.StringYes
content-typeThe Content-Type entity header is used to indicate the media type of the resource. Expected values could be application/json or multipart/form-data.StringYes

Path Parameters:​

ParameterDescriptionTypeRequired
clientIdThis is the unique client ID generated by Nium.StringYes

Example Request:​

curl --request post \\
--url "https://api-test.instarem.com:4803/api/v1/client/{clientId}/payer" \\
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json' \\
--data '{
    "payerName": "John Doe",
    "payerType": "COMPANY",
    "companyName": "Instarem India Pvt Ltd",
    "website": "https://www.instarem.com",
    "email": "john.doe@instarem.com",
    "countryCode": "US",
    "virtualReceivingAccountType": [
        {
            "currencyCode": "USD",
            "label": "GLOBAL" 
        },
        {
            "currencyCode": "GBP",
            "label": "LOCAL" 
        }
    ]
}'

Body Parameters:​

ParameterDescriptionTypeRequired
payerTypeThis field defines the type of payer and the value for this could be Individual or Company.StringYes
companyNameThis is name of the payer company is applicable when the Payer type is Company.StringNo
websiteThis is the business website of the payer company or individual.StringNo
payerNameThis is the Name of an individual when the Payer type is Individual and name of the contact person if the Payer type is Company.StringYes
emailEmail ID of a payer who will be notified about the payment request.StringYes
countryCodeCountry code.StringYes
virtualReceivingAccountType[n].currencyCodeThe currency for virtual receiving account used for VRA allocation. Must be required if client is per payer virtual account approachStringconditional
virtualReceivingAccountType[n].labelThe type for virtual receiving account used for VRA allocation. Must be required if client is per payer virtual account approach and value for this could be LOCAL or GLOBAL or LOCAL,GLOBAL.Stringconditional

Example Response:​

{
    "payerId": "ea81eccc-540a-4ce1-8871-ec22ded7ed64",
    "receivingAccounts": [
        {
            "currencyCode": "GBP",
            "label": "LOCAL",
            "virtualAccount": {
                "virtualReceivingAccountId": null,
                "virtualReceivingAccount": null,
                "bankAccountName": null,
                "bankName": null,
                "bankAddress": null,
                "bankRoutingDetails": null,
                "virtualReceivingAccountRequestId": "14011627389003398",
                "accountNumber": "170561429342"
            },
            "status": "REQUESTED",
            "message": "Your request for new account is already been initiated"
        },
        {
            "currencyCode": "USD",
            "label": "GLOBAL",
            "virtualAccount": {
                "virtualReceivingAccountId": "9dee24ee-998d-4dbf-a651-1e47b41660a1",
                "virtualReceivingAccount": "9109",
                "bankAccountName": "NIUM PTE LTD",
                "bankName": "CITIBANK NA",
                "bankAddress": "CITIBANK NA",
                "bankRoutingDetails": {
                    "routing_code_1": "ABA",
                    "routing_value_1": "036073151",
                    "routing_code_2": "SWIFT",
                    "routing_value_2": "SBI12345"
                },
                "virtualReceivingAccountRequestId": null,
                "accountNumber": "125629574831"
            },
            "status": "COMPLETED",
            "message": "VRA allocated successfully"
        }
    ]
}

Response Parameters:​

ParameterDescriptionType
payerIdUnique payer ID.String
receivingAccounts[n].currencyCodeThe currency for virtual receiving accountString
receivingAccounts[n].labelThe type for virtual receiving account used for VRA allocation and value for this could be LOCAL or GLOBAL or LOCAL,GLOBALString
receivingAccounts[n].virtualAccount.virtualReceivingAccountIdUnique identifier number of virtual receiving account generated by NiumString
receivingAccounts[n].virtualAccount.virtualReceivingAccountVirtual receiving account numberString
receivingAccounts[n].virtualAccount.bankAccountNameBeneficiary nameString
receivingAccounts[n].virtualAccount.bankNameBeneficiary bank nameString
receivingAccounts[n].virtualAccount.bankAddressBeneficiary bank addressString
receivingAccounts[n].virtualAccount.bankRoutingDetails.routing_code_1Routing code 1 (eg IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe).String
receivingAccounts[n].virtualAccount.bankRoutingDetails.routing_value_1IFSC Code of the bank (eg SBIN0000058 for IFSC, 259087 for SORT CODE, 111000025 for ABA CODE, LIABLT20001 for BIC CODE).String
receivingAccounts[n].virtualAccount.bankRoutingDetails.routing_code_2Routing code 1 (eg IFSC for India, SORT CODE for UK, ABA CODE for USA, BIC CODE for Europe).String
receivingAccounts[n].virtualAccount.bankRoutingDetails.routing_value_2IFSC Code of the bank (eg SBIN0000058 for IFSC, 259087 for SORT CODE, 111000025 for ABA CODE, LIABLT20001 for BIC CODE).String
receivingAccounts[n].virtualAccount.virtualReceivingAccountRequestIdGenerated request id for virtual account request against currency: EUR, GBP, AUDString
receivingAccounts[n].virtualAccount.accountNumberReturns 12 digit account number generated by NiumString
receivingAccounts[n].statusVirtual receiving account request status.String
receivingAccounts[n].messageMessage of virtual receiving account request.String