Skip to main content

Create Payment v1 (Deprecated)

Send a payment to a beneficiary. This is Version 1 of the API which is deprecated. Clients are preferred to use V2 version of the api.

Definition​

URL
POST https://api-test.instarem.com:4803/api/v1/payments/create

Header Parameters​

ParameterDescriptionTypeRequired
authorizationAuthentication TokenStringYes
content-typeThe Content-Type entity header is used to indicate the media type of the resource. Expected value is application/json.StringYes
X-CLIENT-IDUnique id for client generated by Nium, Required only in case of partner based model (E.g. 593feb7c7c52bb2357b2df6c).StringNo

Example Request​

curl --location --request POST 'https://api-test.instarem.com:4803/api/v1/payments/create' \\
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "request_id": "1XkQkI34DA",
    "account_number": 101950173983,
    "transaction_number": "ZQ1101",
    "destination_currency": "USD",
    "destination_amount": 1000,
    "local_conversion_currency": "USD",
    "statement_narrative": "Salary",
    "remitter_name": "Instarem",
    "remitter_given_name": true,
    "remitter_account_type": "Company",
    "remitter_bank_account_number": "10022206393",
    "remitter_identification_type": "Company Registration No",
    "remitter_identification_number": "IN1244654",
    "remitter_country_code": "IN",
    "remitter_address": "Sakinaka Mumbai India",
    "remit_purpose_code": "IR001",
    "remitter_source_of_income": "Cross border remittence",
    "remitter_beneficiary_relationship": "Employee",
    "remitter_contact_number": "1234567890",
    "remitter_dob": "",
    "remitter_city": "Mumbai",
    "remitter_postcode": "4703101",
    "remitter_state": "Maharashtra",
    "beneficiary_name": "Mark Jobs",
    "beneficiary_address": "New york city USA",
    "beneficiary_city": "New York",
    "beneficiary_country_code": "US",
    "beneficiary_email": "mark@abc.com",
    "beneficiary_account_type": "Individual",
    "beneficiary_contact_number": "1234567891",
    "beneficiary_state": "New York",
    "beneficiary_postcode": "10005",
    "beneficiary_account_number": "12342346545123",
    "beneficiary_bank_account_type": "",
    "beneficiary_bank_name": "Bank of America",
    "beneficiary_bank_code": "",
    "beneficiary_identification_type": "Company Organization Code",
    "beneficiary_identification_value": "12345678-X",
    "beneficiary_account_identifier_type": "MOBILE",
    "beneficiary_account_identifier_value": "+919021221212",
    "beneficiary_card_token": "f758a897-80e3-4d81-ba4d-baf860f8c2a8",
    "beneficiary_contact_country_code": "+1",
    "beneficiary_name_local_language": "マーク ジョブス",
    "routing_code_type_1": "SWIFT",
    "routing_code_value_1": "WSD12345",
    "routing_code_type_2": "ACH CODE",
    "routing_code_value_2": "222333123",
    "routing_code_type_3": "",
    "routing_code_value_3": "",
    "original_remitter_fi": "",
    "swift_fee_payer": "ACO",
    "additional_info": {
        "trade_order_id": "",
        "trade_time": "",
        "trade_currency": "",
        "trade_amount": "",
        "trade_name": "",
        "trade_count": "",
        "goods_carrier": "",
        "service_detail": "",
        "service_time": "",
        "cash_pickup": "",
        "trade_platform_name": "e-commerce"
    },
    "document_reference": "6012a81b11c68700c02ef11b"
}'

Body Parameters​

ParameterDescriptionTypeRequired
request_idA unique request ID specified by the client in the request.StringYes
account_number12 digit account number as provided by Instarem.NumberYes
transaction_numberA unique transaction number specified by the client. Duplicate transaction number will be rejected.StringYes
destination_currencyCurrency the payment to be made to beneficiary (3-letter ISO-4217 code).StringYes
destination_amountAmount to be paid to beneficiaryNumberYes
local_conversion_ currencyBeneficiary's country local currencyStringNo
equivalent_amountThis is the amount used for converting destination currency's amount, i.e. 100 EUR equivalent is converted to 120 USD destination amount and beneficiary is paid 120 USD. It Must be specified if destination_amount is 0NumberConditional
equivalent_currencyThis is the currency used for converting destination currency, i.e. EUR equivalent is converted to USD destination currency. Must be specified if equivalent amount is present.StringConditional
statement_narrativePayment NarrationStringYes
deposit_methodDeposit Method is CASH, BANK, CARD or WALLETStringNo
remitter_nameRemitter nameStringConditional
remitter_given_nameIndicates whether the remitters name should allow initialsBooleanNo
remitter_account_typeRemitter account type either Individual or CompanyStringYes
remitter_bank_account_numberRemitter Bank Account NumberStringNo
remitter_identification_typeOne of Registration Number, Registration ID, ACRA,Travel agent License number,Company Registration No,License No,ARNU,DRLC,NIDN,CCPT.StringConditional
remitter_identification_numberRemitter identification number is the document identifier i.e. IN1244654StringConditional
remitter_country_codeRemitter country code (2-letter ISO 3166-2 country code)StringConditional
remitter_addressRemitter addressStringConditional
remit_purpose_codeThe purpose for the payment, i.e. IR001. Use Instarem's data reference for purpose code.StringConditional
remitter_source_of_incomeRemitter source of income.StringNo
remitter_beneficiary_relationshipRemitter beneficiary relationshipStringNo
remitter_contact_numberRemitter contact numberStringNo
remitter_dobRemitter Date of birth (YYYY-MM-DD)StringNo
remitter_cityRemitter cityStringNo
remitter_postcodeRemitter postcodeStringNo
remitter_stateRemitter stateStringNo
remitter_place_of_birthRemitter place of birth (2-letter ISO 3166-2 country code)StringConditional
remitter_nationalityRemitter nationality (2-letter ISO 3166-2 country code)StringConditional
remitter_occupationRemitter occupation, i.e.EXECUTIVE. Use Instarem's data reference for remitter occupation.StringNo
beneficiary_nameBeneficiary nameStringYes
beneficiary_addressBeneficiary addressStringNo
beneficiary_cityBeneficiary cityStringNo
beneficiary_country_codeBeneficiary country code (2-letter ISO 3166-2 country code)StringYes
beneficiary_emailBeneficiary emailStringNo
beneficiary_account_typeBeneficary account type either Individual or CompanyStringYes
beneficiary_contact_numberBeneficiary contact numberStringNo
beneficiary_dobBeneficiary Date of birth (YYYY-MM-DD)StringNo
beneficiary_establishment_dateBeneficiary Establishment Date (YYYY-MM-DD)StringNo
beneficiary_stateBeneficiary stateStringNo
beneficiary_postcodeBeneficiary postcodeStringNo
beneficiary_wallet_idBeneficiary wallet idStringConditional
beneficiary_account_numberBeneficiary account numberStringConditional
beneficiary_bank_account_typeBeneficiary Bank Account Type can be one of Checking, Saving or MaestraStringNo
beneficiary_bank_nameBeneficiary bank nameStringConditional
beneficiary_bank_codeBeneficiary bank codeStringNo
beneficiary_identification_typeOne of Company Organization Code, Company Social Credit Code, Passport, Company Registration No., CUIT, CUIL, CPF, CNPJ, RUT, CC, NIT, CE, PASS, DNI, RUC, CI.StringNo
beneficiary_identification_valueValue corresponding to Beneficiary Identification TypeStringNo
beneficiary_account_identifier_typeProxy type for this payout are MOBILE, UEN or NRICStringConditional
beneficiary_account_identifier_valueProxy values are dependent on proxy typeStringConditional
beneficiary_card_tokenCard tokenStringNo
beneficiary_contact_country_codeContact country codeStringNo
beneficiary_name_local_languageBeneficiary's name in local language (e.g. Japanese Katakana)StringNo
routing_code_type_1Routing code type 1 (eg SWIFT for all Countries, IFSC for India, SORT CODE for UK, ACH CODE for USA, BRANCH CODE for Brazil and Bangladesh, BSB CODE for Australia, BANK CODE for HongKong)StringNo
routing_code_value_1Routing code value 1 (eg ADCBINBB or ADCBINBB123 for SWIFT, SBIN0000058 for IFSC, 100000 for SORT CODE, 111000025 for ACH CODE, 012515 for BSB CODE, 151 for BANK CODE)StringNo
routing_code_type_2Routing code type 2 (eg SWIFT for all Countries, IFSC for India, SORT CODE for UK, ACH CODE for USA, BRANCH CODE for Brazil and Bangladesh, BSB CODE for Australia, BANK CODE for HongKong)StringNo
routing_code_value_2Routing code value 2 (eg ADCBINBB or ADCBINBB123 for SWIFT, SBIN0000058 for IFSC, 100000 for SORT CODE, 111000025 for ACH CODE, 012515 for BSB CODE, 151 for BANK CODE)StringNo
routing_code_type_3Routing code type 3 (eg SWIFT for all Countries, IFSC for India, SORT CODE for UK, ACH CODE for USA, BRANCH CODE for Brazil and Bangladesh, BSB CODE for Australia, BANK CODE for HongKong)StringNo
routing_code_ value_3Routing code value 3 (eg ADCBINBB or ADCBINBB123 for SWIFT, SBIN0000058 for IFSC, 100000 for SORT CODE, 111000025 for ACH CODE, 012515 for BSB CODE, 151 for BANK CODE)StringNo
original_remitter_fiRemitter fiStringNo
swift_fee_payerSwift fee payer either ACO,SHA or BEN.StringNo
beneficiary_card_numberCard numberStringNo
beneficiary_card_expiry_dateCard expiration date in the format YYYY-MMStringNo
remitter_source_of_fundsRemitters source of fundsStringNo
additional_info.trade_order_idTrade order idStringNo
additional_info.trade_timeTrade timeStringNo
additional_info.trade_currencyTrade currencyStringNo
additional_info.trade_amountTrade amountNumberNo
additional_info.trade_nameTrade nameStringNo
additional_info.trade_countTrade countIntegerNo
additional_info.goods_carrierGoods carrierStringNo
additional_info.service_detailService detailStringNo
additional_info.service_timeService timeStringNo
additional_info.cash_pickupCash pickupStringNo
additional_info.trade_platform_nameTrade platform name for E-commerce payoutStringNo
payout_methodPayout Method either CASH_PAYOUT or BANK or CARD or WALLET or PROXY or SWIFTStringNo
document_referenceDocument with reference to transactionsStringNo

Example Response​

{
    "reference_number": "ZQ1101",
    "payment_id": "PY10001485",
    "status": "IN_PROCESS",
    "sub_status": "",
    "status_description": "Payment in internal process",
    "created_at": "2017-06-16T17:25:52.136+05:30",
    "updated_at": "2017-06-16T17:26:20.670+05:30"
}

Response Parameters​

ParameterDescriptionType
reference_numberTransaction Reference NumberString
payment_idTransaction idString
statusTransaction StatusString
sub_statusTransaction Sub StatusString
status_descriptionTransaction Status detailsString
created_atDate and time (UTC) of transaction.String
updated_atDate and time (UTC) of transaction.String