Transfer: Perform Transfer
Partners use this method to initiate and confirm the fund transfer operation via GloRemit. The method is non-reversible and committed in real-time. Whenever applicable, Partners should use Get Validation (REST) to check and confirm the validity of a Beneficiary account before using this method to ensure highest success rate.
Perform Transfer (REST) would always return “968-Transaction Pending” if the transaction is accepted. Partners are required to call Get Transaction Status (REST) to retrieve the final status of the sent transaction. Normally it will take a few seconds to process and finalize a transaction’s status.
Definition:
POST v1/payments/transfers
Sample request:
curl -v -X POST http://staging-gloremit.tranglo.com:2014/v1/payments/transfers \
-H "Content-Type: application/json" \
-H "Authorization: GLOREMIT <UID>:<PWD>:<rspSign>" \
-d '{ "UIDBranch":"", "transID":"1206", "sFirstName":"Kai", "sLastName":"Yen", "sIdType":1, "sIdNum":"710320-71-5379", "sIdExpiry":"2017-09-06", "sContactNum":"1", "sOccupation":"1", "sFundSource":"1", "sBirthDate":"1971-03-20 00:00:00.000", "sEmail":"[email protected]", "sAddress":"1", "sCity":"1", "sPostCode":"1", "sCountry":"MY", "sCurrency":"MYR", "bCountry":"PH", "bCurrency":"PHP", "trxValue":200, "bFirstName":"Oppo", "bLastName":"Frank", "bAccType":5, "bIssuerCode":"CPCL", "BankProvince":"1", "BankCity":"1", "BankBranchName":"1", "BankBranchCode":"1", "bAccNum":"123", "bIdType":1, "bIdNum":"1231111111111", "bContactNum":"0146854044", "Relationship":"MUM", "bAddress":"1", "bCity":"1", "bPostCode":"1", "bEmail":"[email protected]", "bProvinceCode":"1", "bRegencyCode":"1", "bPayoutID":"", "bPayoutPIN":"", "bPurposeCode":"1000", "bNationality":"MY", "bBirthdate":"1982-09-06", "sOriginCountry":"MY" }'
Request description
| Parameter Name | Required | Min/Max Length | Type | Description | Remark |
| UID | M | 5/50 | Alphanumeric | Username for validation. | Mandatory for all countries and beneficiary account types |
| PWD | M | 5/50 | Alphanumeric | Password for validation, 3DES encrypted. | Mandatory for all countries and beneficiary account types |
| rspSign | M | 32/50 | Alphanumeric | Digital signature of RSP. (Please refer to Digital signature) | Mandatory for all countries and beneficiary account types |
| UIDBranch | O | 1/16 | Numeric | RSP branch identifier. If no branch ID, value as NULL. | Optional for all countries and beneficiary account types |
| transID | M | 6/64 | Alphanumeric | 6 digits or more unique transaction ID from RSP on 7 day basis. Duplicated ID within the last 7 calendar days (GMT +8 timezone) will be declined. If the same transID were used, the system will validate against the transaction details. * The new request with DIFFERENT transaction details will be rejected with error duplicate transID, else system will respond the same as per first request. | Mandatory for all countries and beneficiary account types |
| sFirstName | M | 1/100 | Alphanumeric | Sender's First Name. | Mandatory for all countries and beneficiary account types if sender last name is blank |
| sLastName | O | 1/100 | Alphanumeric | Sender's Last Name. | Mandatory for all countries and beneficiary account types if sender first name is blank |
| sIdType | M | 1/30 | Numeric | Sender Identification Type. (Please refer to Sender) | Mandatory for all countries and beneficiary account types |
| sIdNum | M | 8/50 | Alphanumeric | Sender Identification Number. | Mandatory for all countries and beneficiary account types |
| sIdExpiry | C | 10/10 | String | Sender ID Expiry Date. Date Format: MM/DD/YYYY DD/MM/YYYY D/M/YYYY M/D/YYYY YYYY/M/D YYYY/MM/DD | Conditional for all countries and beneficiary account types |
| sContactNum | O | 8/30 | Numeric | Sender Contact Number. Please specify in Country code + MSISDN format. For e.g. Indonesia = 628123456789. | Mandatory for all countries and beneficiary account types |
| sOccupation | O | 1/50 | Alphanumeric | Sender Occupation. | Optional for all countries and beneficiary account types |
| sFundSource | M | 1/50 | Alphanumeric | Sender’s source of fund. (Please refer to Sender) | Mandatory for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| sBirthDate | M | 10/10 | Alphanumeric | Sender’s Birth date. Date Format: MM/DD/YYYY DD/MM/YYYY D/M/YYYY M/D/YYYY YYYY/M/D YYYY/MM/DD | Mandatory for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| sEmail | O | 1/50 | Alphanumeric | Sender email address. | Optional for all countries and beneficiary account types |
| sAddress | M | 2/50 | Alphanumeric | Sender’s Full Address. (Simplified address is acceptable, e.g. Hotel Name, City, Country) | Mandatory for all countries and beneficiary account types |
| sCity | O | 2/30 | Alphanumeric | Sender’s resident city. | Optional for most countries and beneficiary account types except mandatory for: Country(bAccType) Australia (1) Ghana (1,2) SEPA Countries (1) Uganda (2) China (8) *Not applicable for Bill Payment (bAccType=6) |
| sPostCode | O | 1/50 | Numeric | Sender’s address postcode. | Optional for all countries and beneficiary account types |
| sCountry | M | 2/5 | Alphanumeric | Sender’s Country. (Country value serves as identity purpose only. It has no impact on Sender or Beneficiary currency used.) Accept ISO 3166-1 Alpha-2 or Alpha-3 ONLY (Please refer to ISO 3166 Country Code) | Mandatory for all countries and beneficiary account types |
| sCurrency | M | 3/6 | Alphanumeric | RSP Currency Code as per RSP GSVA Wallet. Do not send as Sender currency. (Please refer to ISO 4217 Currency Code) | Mandatory for all countries and beneficiary account types |
| bCountry | M | 2/5 | Alphanumeric | Beneficiary’s Country. (Country value serves as identity purpose only. It has no impact on Sender or Beneficiary currency used.) Accept ISO 3166-1 Alpha-2 ONLY (Please refer to ISO 3166 Country Code) | Mandatory for all countries and beneficiary account types |
| bCurrency | M | 3/6 | Alphanumeric | Beneficiary’s Currency Code. (Please refer to ISO 4217 Currency Code) | Mandatory for all countries and beneficiary account types |
| CurrToken | O | 16/25 | Alphanumeric | For Future Use. | Optional for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| sAmount | O | 1/16 | Numeric | Sender Amount from RSP based on sCurrency. * Cannot leave it blank. If does not have this information, please put 0 in sAmount field, and cannot leave it as blank. | Optional for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| trxValue | M | 1/16 | Numeric | Total Amount. Please specify the total amount to send denominated in bCurrency. | Mandatory for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| bFirstName | M | 1/100 | Alphanumeric | Beneficiary's first name. * If Credit to China Bank Account, FirstName is Given name. Best practice, if name is in Chinese, put all characters in bFirstName field and leave bLastName empty. If the name submitted in Roman Character (E.G. English), system will send a SMS to the beneficiary to enter the name according to the bank system. | Mandatory for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| bLastName | O | 1/100 | Alphanumeric | Beneficiary's last name. * If Credit to China Bank Account, LastName is the Sur name Best practice, if name is in Chinese, put all characters in bFirstName field and leave bLastName empty. If the name submitted in Roman Character (E.G. English), system will send a SMS to the beneficiary to enter the name according to the bank system. | Mandatory for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| bAccType | M | 1/30 | Numeric | Beneficiary Account Type. (Please refer to Beneficiary) | Mandatory for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| bIssuerCode | M | 3/16 | Alphanumeric | Beneficiary Account Issuer Code. * such as banks, e-wallet operator or mobile operators. (Please refer to Service Spec) | Mandatory for all countries and beneficiary account types |
| BankProvince | O | 1/100 | Alphanumeric | Bank located province. | Optional for all countries and beneficiary account types |
| BankCity | O | 1/100 | Alphanumeric | Bank located city. * Reserve for future purpose | Optional for all countries and beneficiary account types |
| BankBranchName | O | 1/100 | Alphanumeric | Reserve for future purpose. | Optional for most countries and beneficiary account types except mandatory for: Country(bAccType) Japan (1) |
| BankBranchCode | C | 1/100 | Alphanumeric | Bank Branch Code or IFSC code. * If and only if Credit to Australia, Bangladesh, India and Japan Bank Account (Please refer to GloRemit API Code List) | Conditional for most countries and beneficiary account types except mandatory for: Country(bAccType) Bangladesh (1,10) India (1,7,10) Thailand (1) Australia (1) Brazil (1) |
| bAccNum | M | 1/45 | Alphanumeric | Beneficiary Account Number or any other unique account identifier as determined by Beneficiary issuer Optional when bAccType = 5 (Cash Pickup). | Mandatory for all countries and beneficiary account types |
| bIdType | C | 1/30 | Alphanumeric | Beneficiary Identification Type. (Please refer to Beneficiary) * Cannot leave it blank. If does not have this information, please put 0 in bIdType field, cannot leave it as blank. | Conditional for most countries and beneficiary account types except mandatory for: Country(bAccType) Cambodia (1,5) Indonesia (1) Australia (1) Brazil (1) Ghana (1) Mongolia (1) UAE (1) SEPA countries (1) *Not applicable for Bill Payment (bAccType=6) |
| bIdNum | C | 1/30 | Alphanumeric | Beneficiary Identification Number. * It's mandatory if bIdType is 1-7. * If bIdType is 0, can leave it blank. | Conditional for most countries and beneficiary account types except mandatory for: Country(bAccType) Cambodia (1,5) Indonesia (1) Australia (1) Brazil (1) Ghana (1) Mongolia (1) UAE (1) SEPA countries (1) *Not applicable for Bill Payment (bAccType=6) |
| bContactNum | C | 1/50 | Numeric | Beneficiary’s contact number. Please specify in Country code + MSISDN format. For e.g. Indonesia = 628123456789 Tranglo will send SMS for bAccType=5 | Conditional for most countries and beneficiary account types except mandatory for: Country(bAccType) All countries (5,7,9,13) India (1,10) Cambodia (1,2,8) Australia (1) South Korea (1) Brazil (1) Ghana (1,2) Mongolia (1) Hong Kong (1) Egypt (1) UAE (1) China (1) SEPA countries (1) Uganda (2) Vietnam (1) *Not applicable to Bill Payment (bAccType=6) |
| Relationship | M | 1/30 | Alphanumeric | Beneficiary and Sender Relationship. | Mandatory for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| bAddress | C | 1/50 | Alphanumeric | Beneficiary’s Full Address. Required if bAccType=9. | Conditional for most countries and beneficiary account types except mandatory for: Country(bAccType) Australia (1) Mongolia (1,5) Cambodia (1) Japan (1) China (1) SEPA countries (1) All countries (9) *Not applicable for Bill Payment (bAccType=6) |
| bCity | O | 1/50 | Alphanumeric | Beneficiary’s resident city. | Optional for most countries and beneficiary account types except mandatory for: Country(bAccType) Australia (1) All countries (9) *Not applicable for Bill Payment (bAccType=6) |
| bPostCode | O | 1/50 | Numeric | Beneficiary address postcode. | Optional for most countries and beneficiary account types except mandatory for: Country(bAccType) Australia (1) SEPA countries (1) All countries (9) *Not applicable for Bill Payment (bAccType=6) |
| bEmail | O | 1/50 | Alphanumeric | Beneficiary’s email address. | Optional for all countries and beneficiary account types |
| bProvinceCode | C | 1/50 | Alphanumeric | Beneficiary’s province code. Required for PT POS Cash Pickup Transactions and Australia Account Channel Transaction. | Conditional for most countries and beneficiary account types except mandatory for: Country(bAccType) Australia (1) Indonesia (5) *Not applicable for Bill Payment (bAccType=6) |
| bRegencyCode | C | 1/50 | Alphanumeric | Beneficiary’s regency city code. Required for PT POS Cash Pickup Transactions and Australia Account Channel Transaction. | Conditional for most countries and beneficiary account types except mandatory for: Country(bAccType) Australia (1) SEPA countries (1) India, only for TRADE transactions (1,7,10) *Not applicable to Bill Payment (bAccType=6) |
| bPayoutID | C | 1/16 | Alphanumeric | Beneficiary’s payout ID or cash pick up code. To submit the earlier Get_Payoutcode result | Conditional for all countries and beneficiary account types *Not applicable to Bill Payment (bAccType=6) |
| bPayoutPIN | C | 1/30 | Alphanumeric | Beneficiary’s payout PIN or cash pick up password. To submit the earlier Get_Payoutcode result. | Conditional for all countries and beneficiary account types *Not applicable to Bill Payment (bAccType=6) |
| FR_Key | O | 32 | Alphanumeric | Key/Token for Reserved Forex. | Optional for all countries and beneficiary account types *Not applicable for Bill Payment (bAccType=6) |
| bPurposeCode | M | N/A | Numeric | Purpose of the Transaction. (Please refer to Sender) | Mandatory for all countries and beneficiary account types *Not applicable to Bill Payment (bAccType=6) |
| bNationality | O | 2/5 | Alphanumeric | Beneficiary's Nationality. Accept ISO 3166-1 Alpha-2 ONLY Please refer to ISO 3166 Country Code) | Optional for most countries and beneficiary account types except mandatory for: Country(bAccType) All countries (2,7,8,9,10) *Not applicable to Bill Payment (bAccType=6) |
| bBirthDate | O | 8/10 | Alphanumeric | Beneficiary's Birth Date. Date Format: MM/DD/YYYY DD/MM/YYYY D/M/YYYY M/D/YYYY YYYY/M/D YYYY/MM/DD | Optional for all countries and beneficiary account types *Not applicable to Bill Payment (bAccType=6) |
| sOriginCountry | M | 2/2 | Alphanumeric | Origin country of fund. Accept ISO 3166-1 Alpha-2 or Alpha-3 ONLY (Please refer to ISO 3166 Country Code) | Mandatory for all countries and beneficiary account types *Not applicable to Bill Payment (bAccType=6) |
Response Description
GloRemit server will return a JSON format with response code and GTN transaction number when RSP request is accepted.
Sample Response:
{
"TrxStatus":"968",
"GTN":"G3317310424632",
"transID":"1207",
"Description":"Transaction Pending",
"LastBal":"88196588.82",
"CurrRate":11.1997
}
| Paramater Name | Required | Type | Remark |
| TrxStatus | M | Numeric | Transaction status response code. (Please refer to Transaction status) |
| GTN | M | Alphanumeric | Transaction GTN number. (14characters) |
| transID | M | Alphanumeric | Unique Transaction ID from RSP. |
| PayoutPIN | O | Alphanumeric | Payout PIN from cash out supplier. |
| Description | M | Alphanumeric | Transaction description or advice. |
| LastBal | M | Numeric | The latest balance of RSP e-wallet. |
| CurrRate | M | Numeric | The transaction currency rate. |
| Status_Type | O | Alphanumeric | Status Type. Possible Values: • Approved • Cancelled • Failed • Pending • Rejected • Suspected |
M= Mandatory, C= Conditional, O= Optional