Create a Business Profile

post https://{host}/business/v1/profiles

The create business profile API creates a new business profile.

Body Params

Create Business Profile.

targetAudience

string

Defaults to AGENT_FACING

Enumerated value to tailor MoneyGram’s error messages and field metadata to a in-store, digital or crypto customer

agentPartnerId

string

Defaults to 30150519

Unique identifier for the agent or partner

userLanguage

string

Defaults to en-US

Language used by the user/operator

businessDetails

object

Headers

X-MG-ClientRequestId

string

Defaults to 4c79b06f-a2af-4859-82c8-28cbb0bf361b

Client Request Id that can be passed by the client application. Client request Id must be unique within a single session for unique requests. This attribute can be used for ensuring idempotent request processing for some APIs. MoneyGram recommends using a UUID for the value of this field.

X-MG-ConsumerIPAddress

string

IP Address of the system initiating the session.

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
29
1
curl --request POST \
2
     --url https://sandboxapi.moneygram.com/business/v1/profiles \
3
     --header 'X-MG-ClientRequestId: 4c79b06f-a2af-4859-82c8-28cbb0bf361b' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "targetAudience": "AGENT_FACING",
9
  "agentPartnerId": "30150519",
10
  "userLanguage": "en-US",
11
  "businessDetails": {
12
    "businessCountryOfRegistration": "USA",
13
    "address": {
14
      "line1": "100 Main St",
15
      "city": "Dallas",
16
      "countrySubdivisionCode": "US-TX",
17
      "countryCode": "USA",
18
      "postalCode": "75001"
19
    },
20
    "contactDetails": {
21
      "email": "business@mail.com",
22
      "phone": {
23
        "number": "5551231234",
24
        "countryDialCode": "1"
25
      }
26
    }
27
  }
28
}
29
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK. Returns Business Profile ID, if available.

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.