Last Change ID : #OMCF-383
Partner to provide following information for registration
URL
http://partner.domain.com/notification/transaction
MethodHTTP POST
MediaTypeapplication/json
{
"message": "message",
"status":"<status>",
"amount":"<amount>",
"referenceId":"<referenceId>",
"date":"<date>",
"name":"<name>"
}
URL
http://partner.domain.com/notification/sender
MethodHTTP POST
MediaTypeapplication/json
{
"message": "message",
"status":"<status> ACCEPTED|REJECTED",
"senderId":"[Generated Sender Id]",
}
Source IP for callback are :
| Environment | IP |
|---|---|
| Production | 180.179.215.136 |
| UAT | 103.18.141.30,223.165.28.66 |
How get real token https://docs.oxymoney.com/en/api/document
Partner has to pass below mentioned header to each API.
Authorization Bearer <OAuth2 token>
request-time <CURRENT TIME IN MILLISECONDS>
API-#1URL
/endpoint/v1/payout/sender/register
MethodHTTP POST
MediaTypemultipart/formdata
| Field | Description |
|---|---|
| panFile | Multipart filed scan copy PAN Card |
| aadhaarFile | Multipart filed scan copy AADHAAR Card |
| pan | PAN number as format |
| aadhaar | AADHAAR number as per format |
| mobile | MOBILE Sender mobile number |
| name | NAME Sender name as per document |
Email Sender email id |
Please check swagger-sandbox for detail
{"senderId:"<senderId>","otpToken":"token"}
| Code | Description |
|---|---|
| senderId | Registered sender id |
| otpToken | Should be used in cofirmation API in non empty |
| Code | Description |
|---|---|
| 200 | Sender registration request accepted |
| 400 | Request syntax is not valid |
| 500 | System error |
API-#2URL
/endpoint/v1/payout/resendOtp/{senderId}
MethodHTTP GET
| Field | Description |
|---|---|
| sender Id | long filed registered sender id |
{"senderId:"<senderId>","otpToken":"token"}
| Code | Description |
|---|---|
| senderId | Registered sender id |
| otpToken | Should be used in cofirmation API, if status is accepted |
| Code | Description |
|---|---|
| 200 | otp resend successful |
| 400 | Request syntax is not valid |
| 500 | System error |
API-#3URL
/endpoint/v1/payout/sender/confirm
MethodHTTP POST
MediaTypeapplication/json
| Field | Description |
|---|---|
| otp | Six digit number recieved on sender mobile |
| senderId | Obtained from API-#1 |
| otpToken | Obtained from API-#1 |
Please check swagger-sandbox for detail
{"verified": <true or false>,"status":"PENDING","senderId":"senderid","senderKycId":"senderKycId"}
| Code | Description |
|---|---|
| verified | true or false |
| senderKycId | kyc request id |
| senderId | sender id |
| status | status of sender kyc |
Please check swagger-sandbox for detail
| Code | Description |
|---|---|
| 200 | Request executed successfully |
| 400 | Request syntax is not valid |
| 404 | Provided sender id is not found |
| 500 | System error |
URL
/endpoint/v1/payout/sender/status/{senderId}
MethodHTTP GET
MediaTypeapplication/json
| Field | Description |
|---|---|
| senderId | Obtained from API-#1 |
Please check swagger-sandbox for detail
{"status":"<status>"}
| Field | Description |
|---|---|
| status | SUCCESS or FAILED or PENDING |
| Code | Description |
|---|---|
| 200 | Request executed successfully |
| 404 | Provided sender id is not found |
| 500 | System error |
API-#5URL
/endpoint/v1/payout/fundTransfer/{senderId}
MethodHTTP POST
MediaTypeapplication/json
| Field | Description |
|---|---|
| amount | Amount to be transferred |
| senderId | Obtained from API-#1 |
| ifscCode | Beneficiary IFSC code |
| accountNo | Beneficiary account number |
| name | Beneficiary account holder name |
| txnId | transaction id |
Please check swagger-sandbox for detail
{"invoiceId":"<invoiceId>","correlationId":"<correlationId>"}
| Code | Description |
|---|---|
| invoiceId | Unique ID for transaction corelation |
| correlationId | Unique ID for transaction provided by client (txnId) |
| Field | Description |
|---|---|
| 201 | Fund request accepted |
| 400 | Request syntax is not valid |
| 500 | System error |
API#-6URL
/endpoint/v1/payout/invoice/{key}?lookup={lookup}
MethodHTTP GET
MediaTypeapplication/json
| Field | Description |
|---|---|
| invoiceId | Obtailed from API#-4 |
| lookup | can be invoice or coorelation default is invoice id |
Please check swagger-sandbox for detail
{"senderId:"<senderId>","message": "message","status":"COMPLETED/FAILED/PENDING","amount":"<amount>","referenceId":"<referenceId>","date":"<date>","name":"<name>","correlationId":"<correlationId>"}
| Name | Description |
|---|---|
| senderId | Obtained from API-#1 |
| message | Message from bank |
| status | COMPLETED OR FAILED or PENDING |
| amount | Transferred amount |
| referenceId | Bank reference id |
| date | Transfer date in yyyy-MM-dd HH:mm:ss |
| name | Name returned from bank |
| correlationId | Unique ID for transaction provided by client (txnId) |
| Code | Description |
|---|---|
| 200 | Request executed successfully |
| 404 | invoiceId details not found |
| 500 | System error |