Skip to main content
POST
/
user
/
operations
/
request-money-v2
/
{userToken}
Request money
curl --request POST \
  --url https://raas-partner-cv.nomas.cash/v1/user/operations/request-money-v2/{userToken} \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "requestTo": "+19166014999",
  "correlationId": "7011cefb-0c0b-48c1-a68a-7134d32e61e4",
  "destinationPaymentMethodId": "6af8e158-be29-422a-8d69-703d6c343c3c",
  "reason": "Request CrossBorder to ...",
  "recipientAmount": 25,
  "recipientCurrency": "USD"
}
'
{
  "attributionLink": "https://links-dev.nomas.cash/EFUb8",
  "createdAt": "/Date(1776102856022)/",
  "status": "Sent",
  "code": "Ze2i4o",
  "correlationId": "b6bf4bcd-7751-426b-86c6-1b3d72ee5a02",
  "fromUser": {
    "country": "US",
    "phoneNumber": "+19163015400",
    "firstName": "Jose",
    "lastName": "Llontop",
    "userId": "0"
  },
  "toUser": {
    "country": "MX",
    "phoneNumber": "+5215521206706",
    "firstName": "Maria",
    "lastName": "Garcia",
    "email": "",
    "userId": "d8491cd95cae4fa0ad45d765021adbbb"
  },
  "sourcePaymentMethod": {},
  "destinationPaymentMethod": {
    "isPrimary": false,
    "number": "tok_sandbox_9PNgfqqpdpyQpnD1jYkdw1_1111",
    "type": "DebitCard"
  },
  "amount": 500,
  "currency": "MXN",
  "senderAmount": 500,
  "senderCurrency": "MXN",
  "recipientAmout": 500,
  "recipientCurrency": "MXN",
  "estimatedExchangeRate": 1,
  "platId": "22038600-846a-47fd-8733-3b0fa886d894"
}

Authorizations

​
api_key
string
header
required

Path Parameters

​
userToken
string
required

User identifier.

Body

application/json

Credentials and corridor id for the request.

Partner request money v2 body (request-money-v2/{userToken}): beneficiary, amounts, and destination PM.

​
requestTo
string
required

Beneficiary phone (and optionally other aliases) the platform will normalize. Example: +525512345678.

​
correlationId
string
required

Correlation ID

Partner provided operation identifier.

​
recipientAmount
number<double>
required

Recipient amount

Amount to receive

​
recipientCurrency
string
required

Recipient currency

ISO 4217 format

​
destinationPaymentMethodId
string

Destination payout method ID

required if the destinationPaymentMethod parameter is not provided.

ID of the payout method that will receive the money.

You can provide either the payout method ID using this parameter, or the full payout method object using the destinationPaymentMethod parameter.

If both parameters are provided, destinationPaymentMethodId will take precedence and destinationPaymentMethod will be ignored.

​
reason
string

Reason

Reason for the request

​
destinationPaymentMethod
object

Destination payout method

required if the destinationPaymentMethodId parameter is not provided.

The full payout method object that will receive the money.

You can provide either the full payout method object using this parameter, or just the payout method ID using the destinationPaymentMethodId parameter.

If both parameters are provided, this object will be ignored and destinationPaymentMethodId will take precedence.

Response

200 — OK. Request-money operation created.

Scenarios for this response:

ScenarioHow to reproduceTypical code / body
Happy pathValid userToken, corridor, destination PM, and payload.OperationResponsePartner

See also Full scenario matrix.

​
code
string
required

User frendly operation code for support purposes

Example: ABC123.

​
status
string
required

Operation status

Example: Sent, Funding, Funded, Accepted, Rejected, ReadyForPickup, Completed, Failed, OnHold, InTransit, Cancelled.

​
amount
number<double>
required
​
createdAt
string<date-time>
required
​
cancelable
boolean

Indicates if the operation can be cancelled by the funder user.

​
userId
string

User ID

ID of the user who performed the operation.

​
ignoredData
object

Data about the reason why the operation was ignored by the funder user.

​
isIgnored
boolean

Indicates if the operation was ignored by the funder user.

​
attributionLink
string

Attribution link

Link to the operation.

​
toUser
object

Recipient user information

​
fromUser
object

Sender user information

​
estimatedExchangeRate
number<double>

Estimated exchange rate for the operation.

​
destinationPaymentMethod
object

Destination payment method

​
sourcePaymentMethod
object

Source payment method

​
currency
string

Currency code

ISO 4217 format. Example: USD for United States Dollar, MXN for Mexican Peso.

​
reason
string

Reason. Free text.

Example: Hi! I need money.

​
statusDetails
string

Operation status details

​
updatedAt
string<date-time>
​
correlationId
string

Correlation ID

Partner provided operation identifier.